|
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 |
| -## Features |
| 6 | +Installation |
| 7 | +============ |
7 | 8 |
|
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 |
14 |
| - |
15 |
| -- Create a separate branch for Arduino 1.5 |
16 |
| -- Automatically include keywords from keywords.txt of User Arduino libraries |
17 |
| - |
18 |
| -## Installation |
19 |
| - |
20 |
| -This plugin follows the standard runtime path structure, and as such it can be installed with a variety of plugin managers: |
| 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 |
21 | 13 |
|
22 |
| -### [Pathogen](https://github.com/tpope/vim-pathogen) |
| 14 | +Using [Vundle](https://github.com/gmarik/vundle) |
| 15 | +------------- |
23 | 16 |
|
24 |
| -``` |
25 |
| -git clone https://github.com/sudar/vim-arduino-syntax |
26 |
| -``` |
| 17 | +```VimL |
27 | 18 |
|
28 |
| -Remember to run `:Helptags` to generate help tags |
| 19 | + Plugin "sudar/vim-arduino-syntax" |
29 | 20 |
|
30 |
| -### [NeoBundle](https://github.com/Shougo/neobundle.vim) |
| 21 | + And :PluginInstall |
31 | 22 |
|
32 | 23 | ```
|
33 |
| -NeoBundle 'vim-arduino-syntax' |
34 |
| -``` |
35 |
| - |
36 |
| -### [Vundle](https://github.com/gmarik/Vundle.vim) |
| 24 | +Credit |
| 25 | +====== |
37 | 26 |
|
38 |
| -``` |
39 |
| -Plugin 'sudar/vim-arduino-syntax' |
40 |
| -
|
41 |
| -:PluginInstall |
42 |
| -``` |
| 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. |
43 | 28 |
|
44 |
| -### Manual |
| 29 | +TODO |
| 30 | +==== |
45 | 31 |
|
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 |
| 32 | +- Create a separate branch for Arduino 1.5 |
| 33 | +- Automatically include keywords from keywords.txt of Arduino libraries |
49 | 34 |
|
50 |
| -## Contributing |
| 35 | +Contributions |
| 36 | +================ |
51 | 37 |
|
52 | 38 | Contributions are always welcome in the form of pull requests with explanatory comments.
|
53 | 39 |
|
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 |
| 40 | +Other tools for Arduino and Vim |
| 41 | +=========================== |
63 | 42 |
|
64 | 43 | If you are using Arduino with Vim, then also checkout some of my other projects.
|
65 | 44 |
|
|
0 commit comments