Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
33 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -1,11 +1,39 @@ | |||
# Vim Arduino | # Vim Arduino | ||
|
|
||
This script allows you to compile and deploy Arduino (*.pde) files | This script allows you to compile and deploy Arduino (*.pde) sketches | ||
directly from vim. | directly from Vim. | ||
|
|
||
# Requirements | ## Install | ||
|
|
||
You must have the [Arduino][arduino] IDE installed. | The plugin should be organized in a manner that works well with | ||
pathogen. I personally use [janus][janus] to manage my MacVim setup so | |||
adding this line to my `~/.janus.rake` file does the trick: | |||
|
|
||
[arduino]: http://arduino.cc/en/Main/Software | ``` | ||
vim_plugin_task "vim-arduino", "https://github.com/tclem/vim-arduino.git" | |||
``` | |||
|
|||
## Usage | |||
|
|||
You must have a pde (Arduino sketch) open in the current buffer. | |||
|
|||
`<Leader>ac` - Compile the current sketch. | |||
|
|||
`<Leader>ad` - Compile and deploy the current sketch. | |||
|
|||
`<Leader>as` - Open a serial port in `screen`. | |||
|
|
||
|
|||
The default key mapping can be turned off by doing this in your `.vimrc`: | |||
|
|||
``` | |||
let g:vim_arduino_map_keys = 0 | |||
``` | |||
|
|||
## Requirements | |||
|
|||
You must have the [Arduino][arduino] IDE installed. Currently only | |||
Version 0022 is supported. | |||
|
|||
[arduino]: http://arduino.cc/en/Main/Software | |||
[janus]: https://github.com/carlhuda/janus |