diff --git a/README.md b/README.md index 5b1ede0..9ff6c72 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,18 @@ -Syntax highlighting for GAS ARM assembly (up to v7), for the vim text editor. +# arm-syntax-vim -### Installing -Copy /syntax into ~/.vim +GNU ARM assembly syntax highlighting (up to v7), for the vim text editor. + +![A thousand words](img/sample.png) + +### Installation +Copy the [syntax](syntax) folder into your ~/.vim folder + +__with Plug__ +``` +Plug 'ARM9/arm-syntax-vim' +``` __or with Pathogen__ + Clone this repo into your ~/.vim/bundle directory. ``` git clone https://github.com/ARM9/arm-syntax-vim.git @@ -13,7 +23,7 @@ In your .vimrc: ``` au BufNewFile,BufRead *.s,*.S set filetype=arm " arm = armv6/7 ``` -and/or put this line near the top or bottom of your assembly file(s): +or add this line at the top or bottom of your assembly file(s): ``` @ vim:ft=armv5 ``` diff --git a/img/sample.png b/img/sample.png new file mode 100644 index 0000000..b457566 Binary files /dev/null and b/img/sample.png differ