From fdec416659f2f8e9e0cc00eb16c6551f288f9e01 Mon Sep 17 00:00:00 2001 From: David Barnett Date: Fri, 29 Jan 2016 09:46:14 -0800 Subject: [PATCH 1/2] Add usage instructions to README, tweak install instructions --- README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 722365b..5c665ad 100644 --- a/README.md +++ b/README.md @@ -48,21 +48,31 @@ Note that Vroom requires a version of vim built with the `+clientserver` option (run `vim --version` to check). See `:help clientserver` for additional requirements. -The easiest way to install vroom is to cd into the vroom directory and run +If you're on Ubuntu or Debian, you can install +[release packages](https://github.com/google/vroom/releases) from GitHub. + +Otherwise, the easiest way to install vroom is to clone the vroom repository +from Github, cd into the vroom directory, and run ```sh python3 setup.py build && sudo python3 setup.py install ``` -You can also install -[release packages](https://github.com/google/vroom/releases) from github. To -build deb packages yourself, make sure you have a recent stdeb version with -python 3 support installed. - Vim 7.4.384 and later have built-in syntax support for the vroom filetype. You can install the standalone [ft-vroom plugin](https://github.com/google/vim-ft-vroom) for older versions of vim. +## Usage + +Vroom is invoked from the command-line on `.vroom` files. + +```sh +vroom myplugin/vroom/somefile.vroom +``` + +See `vroom --help` and https://github.com/google/vroom/wiki for more info on +usage. + ## Vroom cheat sheet Below is a table of the special symbols and conventions vroom recognizes. See From 02180edf5605a555632fc4975d88aa5a9124b675 Mon Sep 17 00:00:00 2001 From: David Barnett Date: Fri, 29 Jan 2016 11:16:24 -0800 Subject: [PATCH 2/2] =?UTF-8?q?README=20typo:=20Github=E2=86=92GitHub?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5c665ad..c2329b4 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ If you're on Ubuntu or Debian, you can install [release packages](https://github.com/google/vroom/releases) from GitHub. Otherwise, the easiest way to install vroom is to clone the vroom repository -from Github, cd into the vroom directory, and run +from GitHub, cd into the vroom directory, and run ```sh python3 setup.py build && sudo python3 setup.py install ```