-
Notifications
You must be signed in to change notification settings - Fork 309
Doc/readme fixes + improvements #54
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
Merged
+51
−13
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,14 +2,15 @@ | |
|
|
||
| ## Description | ||
|
|
||
| This is a vim plugin that provides [Rust][r] file detection, syntax highlighting, and (optional) autoformatting. | ||
| This is a Vim plugin that provides [Rust][r] file detection, syntax highlighting, formatting, | ||
| [Syntastic][syn] integration, and more. | ||
|
|
||
| ## Installation | ||
|
|
||
| ### Using [Vundle][v] | ||
|
|
||
| 1. Add `Plugin 'rust-lang/rust.vim'` to `~/.vimrc` | ||
| 2. `vim +PluginInstall +qall` | ||
| 2. `:PluginInstall` or `$ vim +PluginInstall +qall` | ||
|
|
||
| *Note:* Vundle will not automatically detect Rust files properly if `filetype | ||
| on` is executed before Vundle. Please check the [quickstart][vqs] for more | ||
|
|
@@ -21,28 +22,65 @@ details. | |
| git clone --depth=1 https://github.com/rust-lang/rust.vim.git ~/.vim/bundle/rust.vim | ||
| ``` | ||
|
|
||
| [r]: https://rust-lang.org | ||
| [v]: https://github.com/gmarik/vundle | ||
| [vqs]: https://github.com/gmarik/vundle#quick-start | ||
| [p]: https://github.com/tpope/vim-pathogen | ||
| [nb]: https://github.com/Shougo/neobundle.vim | ||
|
|
||
| ### Using [NeoBundle][nb] | ||
|
|
||
| 1. Add `NeoBundle 'rust-lang/rust.vim'` to `~/.vimrc` | ||
| 2. Re-open vim or execute `:source ~/.vimrc` | ||
|
|
||
| ## Enabling autoformat | ||
| ### Using [vim-plug][vp] | ||
|
|
||
| 1. Add `Plug 'rust-lang/rust.vim'` to `~/.vimrc` | ||
| 2. `:PlugInstall` or `$ vim +PlugInstall +qall` | ||
|
|
||
| ## Features | ||
|
|
||
| ### Error checking with [Syntastic][syn] | ||
|
|
||
| `rust.vim` automatically registers `rustc` as a syntax checker | ||
| with [Syntastic][syn]. Check Syntastic's documentation for | ||
| information on how to customize its behaviour. | ||
|
|
||
| ### Formatting with [rustfmt][rfmt] | ||
|
|
||
| The `:RustFmt` command will format your code with | ||
| [rustfmt][rfmt] if installed. | ||
|
|
||
| This plugin can optionally format your code using [rustfmt][rfmt] every time a | ||
| buffer is written. Simple put `let g:rustfmt_autosave = 1` in your `.vimrc`. | ||
| Placing `let g:rustfmt_autosave = 1` in your `~/.vimrc` will | ||
| enable automatic running of `:RustFmt` when you save a buffer. | ||
|
|
||
| Do `:help :RustFmt` for further formatting help and customization | ||
| options. | ||
|
|
||
| ### [Playpen][pp] integration | ||
|
|
||
| *Note:* This feature requires [webapi-vim][wav] to be installed. | ||
|
|
||
| The `:RustPlay` command will send the current selection, or if | ||
| nothing is selected the current buffer, to the [Rust playpen][pp]. | ||
|
|
||
| ## Help | ||
|
|
||
| Further help can be found in the documentation with `:help rust`. | ||
|
|
||
| Detailed help can be found in the documentation with `:help rust`. | ||
| Helptags (`:help helptags`) need to be generated for this plugin | ||
| in order to navigate the help. Most plugin managers will do this | ||
| automatically, but check their documentation if that is not the case. | ||
|
|
||
| ## License | ||
|
|
||
| Like Rust, rust.vim is primarily distributed under the terms of both the MIT | ||
| license and the Apache License (Version 2.0). See LICENSE-APACHE and | ||
| LICENSE-MIT for details. | ||
| LICENSE-MIT for details. | ||
|
|
||
| [r]: https://rust-lang.org | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. oh, they're moved here, sorry |
||
| [v]: https://github.com/gmarik/vundle | ||
| [vqs]: https://github.com/gmarik/vundle#quick-start | ||
| [p]: https://github.com/tpope/vim-pathogen | ||
| [nb]: https://github.com/Shougo/neobundle.vim | ||
| [vp]: https://github.com/junegunn/vim-plug | ||
| [rfmt]: https://github.com/rust-lang-nursery/rustfmt | ||
| [syn]: https://github.com/scrooloose/syntastic | ||
| [wav]: https://github.com/mattn/webapi-vim | ||
| [pp]: https://play.rust-lang.org/ | ||
|
|
||
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
doesn't this break the links?