Skip to content

Added fixes mentioned in previous PR #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 39 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,42 @@
vim-arduino-syntax
==================

Love Arduino and Vim? Then use this syntax file and get syntax highlighting for Arduino functions in vim.

Installation
============

Manual
------
- Copy `syntax/arduino.vim` file into your `~/.vim/syntax` directory
- Copy `ftdetect/arduino.vim` file into your `~/.vim/ftdetect` directory

Using [Vundle](https://github.com/gmarik/vundle)
-------------

```VimL

Plugin "sudar/vim-arduino-syntax"

And :PluginInstall

```
Credit
======

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.

TODO
====

- Create a separate branch for Arduino 1.5
- Automatically include keywords from keywords.txt of Arduino libraries

Contributions
================

#vim-arduino-syntax

Are you in love with Vim and can't stand the [Official Arduino IDE](http://arduino.cc/en/Main/Software)

##Features
* Arduino 1.5.8 support (check beta branch)
* Arduino 1.0. support (main branch)
* Arduino indent and syntax highlighting
* Support for libraries provided by the IDE
* Support for external libraries (on request)
* Autocompletion (using omnicomplete)

##TODO
* Let us know if you want any new features

##Installation

This plugin follows the standard runtime path structure, and as such it can be installed with a variety of plugin managers:

* [Pathogen](https://github.com/tpope/vim-pathogen)
* `git clone https://github.com/sudar/vim-arduino-syntax`
* Remember to run `:Helptags` to generate help tags
* [NeoBundle](https://github.com/Shougo/neobundle.vim)
* `NeoBundle 'vim-arduino-syntax'`
* [Vundle](https://github.com/gmarik/Vundle.vim)
* `Plugin 'sudar/vim-arduino-syntax'
:PluginInstall`
* manual
* Copy syntax/arduino.vim file into your ~/.vim/syntax directory
Copy ftdetect/arduino.vim file into your ~/.vim/ftdetect directory

##Contributing
Contributions are always welcome in the form of pull requests with explanatory comments.

Other tools for Arduino and Vim
===========================

If you are using Arduino with Vim, then also checkout some of my other projects.
* Add library specific support using instructions from here. (coming soon)
* Request adding more external libraries (complete within a few hours)
* Report bugs
* Request support for libraries

- [Arduino snippets for Vim](https://github.com/sudar/vim-arduino-snippets)
- [Arduino Make file](https://github.com/sudar/Arduino-Makefile)
##Contributors
* [z3t0](https://github.com/z3t0) - Active contributor
* [sudar](https://github.com/sudar) - Owner and contributor
Loading