|
1 | 1 | vim-arduino-syntax
|
2 |
| -================== |
| 2 | +=================== |
3 | 3 |
|
4 | 4 | Love Arduino and Vim? Then use this syntax file and get syntax highlighting for Arduino functions in vim.
|
5 | 5 |
|
6 |
| -Installation |
7 |
| -============ |
| 6 | +## Features |
8 | 7 |
|
9 |
| -Manual |
10 |
| ------- |
11 |
| -- Copy `syntax/arduino.vim` file into your `~/.vim/syntax` directory |
12 |
| -- Copy `ftdetect/arduino.vim` file into your `~/.vim/ftdetect` directory |
| 8 | +- Arduino indent and syntax highlighting |
| 9 | +- Support for libraries provided by the IDE |
| 10 | +- Support for external libraries (on request) |
| 11 | +- Autocompletion (using omnicomplete) |
| 12 | + |
| 13 | +## TODO |
13 | 14 |
|
14 |
| -Using [Vundle](https://github.com/gmarik/vundle) |
15 |
| -------------- |
| 15 | +- Create a separate branch for Arduino 1.5 |
| 16 | +- Automatically include keywords from keywords.txt of User Arduino libraries |
16 | 17 |
|
17 |
| -```VimL |
| 18 | +## Installation |
18 | 19 |
|
19 |
| - Plugin "sudar/vim-arduino-syntax" |
| 20 | +This plugin follows the standard runtime path structure, and as such it can be installed with a variety of plugin managers: |
20 | 21 |
|
21 |
| - And :PluginInstall |
| 22 | +### [Pathogen](https://github.com/tpope/vim-pathogen) |
22 | 23 |
|
23 | 24 | ```
|
24 |
| -Credit |
25 |
| -====== |
| 25 | +git clone https://github.com/sudar/vim-arduino-syntax |
| 26 | +``` |
26 | 27 |
|
27 |
| -The syntax file was originally created by Johannes Hoff. I regenerated the file using his [python script](https://bitbucket.org/johannes/arduino-vim-syntax) and added some additional changes on top of it. |
| 28 | +Remember to run `:Helptags` to generate help tags |
28 | 29 |
|
29 |
| -TODO |
30 |
| -==== |
| 30 | +### [NeoBundle](https://github.com/Shougo/neobundle.vim) |
31 | 31 |
|
32 |
| -- Create a separate branch for Arduino 1.5 |
33 |
| -- Automatically include keywords from keywords.txt of Arduino libraries |
| 32 | +``` |
| 33 | +NeoBundle 'vim-arduino-syntax' |
| 34 | +``` |
34 | 35 |
|
35 |
| -Contributions |
36 |
| -================ |
| 36 | +### [Vundle](https://github.com/gmarik/Vundle.vim) |
| 37 | + |
| 38 | +``` |
| 39 | +Plugin 'sudar/vim-arduino-syntax' |
| 40 | +
|
| 41 | +:PluginInstall |
| 42 | +``` |
| 43 | + |
| 44 | +### Manual |
| 45 | + |
| 46 | +- Copy `syntax/arduino.vim` file into your `~/.vim/syntax` directory |
| 47 | +- Copy `ftdetect/arduino.vim` file into your `~/.vim/ftdetect` directory |
| 48 | +- Copy `indent/arduino.vim` file into your `~/.vim/indent` directory |
| 49 | + |
| 50 | +## Contributing |
37 | 51 |
|
38 | 52 | Contributions are always welcome in the form of pull requests with explanatory comments.
|
39 | 53 |
|
40 |
| -Other tools for Arduino and Vim |
41 |
| -=========================== |
| 54 | +## Credit |
| 55 | + |
| 56 | +The syntax file was originally created by Johannes Hoff. I regenerated the file using his [python script](https://bitbucket.org/johannes/arduino-vim-syntax) and added some additional changes on top of it. |
| 57 | + |
| 58 | +The most recent file was generated by [z3t0](https://github.com/z3t0) |
| 59 | + |
| 60 | +Support for indent was added by [KevinSjoberg](https://github.com/KevinSjoberg) |
| 61 | + |
| 62 | +## Other tools for Arduino and Vim |
42 | 63 |
|
43 | 64 | If you are using Arduino with Vim, then also checkout some of my other projects.
|
44 | 65 |
|
|
0 commit comments