diff options
author | w0rp <devw0rp@gmail.com> | 2017-07-19 13:36:30 +0100 |
---|---|---|
committer | w0rp <devw0rp@gmail.com> | 2017-07-19 13:36:30 +0100 |
commit | cbdf10a1293c63e9a09213285a36986f4f0cb90d (patch) | |
tree | 54d49f816df5ac349a6d0aae61d3799aa5ace0b9 | |
parent | 0b50ebb0f0116f38782fed4aebf25588433352a2 (diff) | |
download | ale-cbdf10a1293c63e9a09213285a36986f4f0cb90d.zip |
Fix #573 - Update the README to recommend installing via the built-in package system
-rw-r--r-- | README.md | 82 |
1 files changed, 43 insertions, 39 deletions
@@ -23,9 +23,9 @@ background with a command `ALEFix`. 1. [Supported Languages and Tools](#supported-languages) 2. [Usage](#usage) 3. [Installation](#installation) - 1. [Installation with Pathogen](#installation-with-pathogen) - 2. [Installation with Vundle](#installation-with-vundle) - 3. [Manual Installation](#manual-installation) + 1. [Installation with Vim package management](#standard-installation) + 2. [Installation with Pathogen](#installation-with-pathogen) + 3. [Installation with Vundle](#installation-with-vundle) 4. [Contributing](#contributing) 5. [FAQ](#faq) 1. [How do I disable particular linters?](#faq-disable-linters) @@ -155,71 +155,75 @@ for different filetypes with the `g:ale_fixers` variable. See `:help ale-fix`. To install this plugin, you should use one of the following methods. For Windows users, replace usage of the Unix `~/.vim` directory with -`%USERPROFILE%\_vim`, or another directory if you have configured +`%USERPROFILE%\vimfiles`, or another directory if you have configured Vim differently. On Windows, your `~/.vimrc` file will be similarly stored in `%USERPROFILE%\_vimrc`. -<a name="installation-with-pathogen"></a> +<a name="standard-installation"></a> -### 3.i. Installation with Pathogen +### 3.i. Installation with Vim package management -To install this module with [Pathogen](https://github.com/tpope/vim-pathogen), -you should clone this repository to your bundle directory, and ensure -you have the line `execute pathogen#infect()` in your `~/.vimrc` file. -You can run the following commands in your terminal to do so: +In Vim 8 and NeoVim, you can install plugins easily without needing to use +any other tools. Simply clone the plugin into your `pack` directory. + +### Vim 8 on Unix ```bash -cd ~/.vim/bundle -git clone https://github.com/w0rp/ale.git +mkdir -p ~/.vim/pack/git-plugins/start +git clone https://github.com/w0rp/ale.git ~/.vim/pack/git-plugins/start/ale ``` -<a name="installation-with-vundle"></a> +### NeoVim on Unix -### 3.ii. Installation with Vundle +```bash +mkdir -p ~/.local/share/nvim/site/pack/git-plugins/start +git clone https://github.com/w0rp/ale.git ~/.local/share/nvim/site/pack/git-plugins/start/ale +``` -You can install this plugin using [Vundle](https://github.com/VundleVim/Vundle.vim) -by using the path on GitHub for this repository. +### Vim 8 on Windows -```vim -Plugin 'w0rp/ale' +```bash +# Run these commands in the "Git for Windows" Bash terminal +mkdir -p ~/vimfiles/pack/git-plugins/start +git clone https://github.com/w0rp/ale.git ~/vimfiles/pack/git-plugins/start/ale ``` -See the Vundle documentation for more information. +### Generating documentation -<a name="manual-installation"></a> +You can add the following line to your vimrc files to generate documentation +tags automatically, if you don't have something similar already, so you can use +the `:help` command to consult ALE's online documentation: -### 3.iii. Manual Installation +```vim +silent! helptags ALL +``` + +<a name="installation-with-pathogen"></a> -For installation without a package manager, you can clone this git repository -into a bundle directory as with pathogen, and add the repository to your -runtime path yourself. First clone the repository. +### 3.ii. Installation with Pathogen + +To install this module with [Pathogen](https://github.com/tpope/vim-pathogen), +you should clone this repository to your bundle directory, and ensure +you have the line `execute pathogen#infect()` in your `~/.vimrc` file. +You can run the following commands in your terminal to do so: ```bash cd ~/.vim/bundle git clone https://github.com/w0rp/ale.git ``` -Then, modify your `~/.vimrc` file to add this plugin to your runtime path. - -```vim -set nocompatible -filetype off +<a name="installation-with-vundle"></a> -let &runtimepath.=',~/.vim/bundle/ale' +### 3.iii. Installation with Vundle -filetype plugin on -``` - -You can add the following line to generate documentation tags automatically, -if you don't have something similar already, so you can use the `:help` command -to consult ALE's online documentation: +You can install this plugin using [Vundle](https://github.com/VundleVim/Vundle.vim) +by using the path on GitHub for this repository. ```vim -silent! helptags ALL +Plugin 'w0rp/ale' ``` -Because the author of this plugin is a weird nerd, this is his preferred -installation method. +See the Vundle documentation for more information. <a name="contributing"></a> |