Skip to content

Commit 2c4d6b6

Browse files
committed
Update the readme
1 parent b530986 commit 2c4d6b6

File tree

1 file changed

+33
-5
lines changed

1 file changed

+33
-5
lines changed

README.md

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,39 @@
11
# Vim Arduino
22

3-
This script allows you to compile and deploy Arduino (*.pde) files
4-
directly from vim.
3+
This script allows you to compile and deploy Arduino (*.pde) sketches
4+
directly from Vim.
55

6-
# Requirements
6+
## Install
77

8-
You must have the [Arduino][arduino] IDE installed.
8+
The plugin should be organized in a manner that works well with
9+
pathogen. I personally use [janus][janus] to manage my MacVim setup so
10+
adding this line to my `~/.janus.rake` file does the trick:
911

10-
[arduino]: http://arduino.cc/en/Main/Software
12+
```
13+
vim_plugin_task "vim-arduino", "https://github.com/tclem/vim-arduino.git"
14+
```
15+
16+
## Usage
17+
18+
You must have a pde (Arduino sketch) open in the current buffer.
19+
20+
`<Leader>ac` - Compile the current sketch.
21+
22+
`<Leader>ad` - Compile and deploy the current sketch.
23+
24+
`<Leader>as` - Open a serial port in `screen`.
1125

26+
27+
The default key mapping can be turned off by doing this in your `.vimrc`:
28+
29+
```
30+
let g:vim_arduino_map_keys = 0
31+
```
32+
33+
## Requirements
34+
35+
You must have the [Arduino][arduino] IDE installed. Currently only
36+
Version 0022 is supported.
37+
38+
[arduino]: http://arduino.cc/en/Main/Software
39+
[janus]: https://github.com/carlhuda/janus

0 commit comments

Comments
 (0)