Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add cargo commands to readme #447

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add cargo commands to readme #447

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5b8f982
add cargo commands to the readme
krtbgb Jun 17, 2021
3e289ca
remove unnecessary colons
krtbgb Jun 17, 2021
a954b30
add heading
krtbgb Jun 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,23 @@ NeoBundle 'rust-lang/rust.vim'

## Features

### Manage packages with [Cargo][cargo]
* `:Cargo`
* `:Cbuild` Compile the current package
* `:Ccheck` Analyze the current package and report errors, but don't build object files
* `:Cclean` Remove the target directory
* `:Cdoc` Build this package's and its dependencies' documentation
* `:Cnew` Create a new cargo package
* `:Cinit` Create a new cargo package in an existing directory
* `:Crun` Run a binary or example of the local package
* `:Ctest` Run the tests
* `:Cbench` Run the benchmarks
* `:Cupdate` Update dependencies listed in Cargo.lock
* `:Csearch` Search registry for crates
* `:Cpublish` Package and upload this package to the registry
* `:Cinstall` Install a Rust binary. Default location is $HOME/.cargo/bin
* `:Cruntarget` Run with specified target

### Error checking with [Syntastic][syn]

`rust.vim` automatically registers `cargo` as a syntax checker with
Expand Down Expand Up @@ -127,6 +144,7 @@ LICENSE-MIT for details.
[vp]: https://github.com/junegunn/vim-plug
[d]: https://github.com/Shougo/dein.vim
[rfmt]: https://github.com/rust-lang-nursery/rustfmt
[cargo]: https://doc.rust-lang.org/cargo/commands/cargo.html
[syn]: https://github.com/scrooloose/syntastic
[tgbr]: https://github.com/majutsushi/tagbar
[uctags]: https://ctags.io
Expand Down