diff --git a/INSTALL.md b/INSTALL.md index 426539d..23325d1 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,26 +1,69 @@ ### [Vim](http://www.vim.org/) -#### Install using Git +#### Install + +These are the default instructions using Vim 8's `|packages|` feature. See +sections below, if you use other plugin managers. + +1. Create theme folder (in case you don't have yet): + +``` +mkdir -p ~/.vim/pack/themes/start +``` + +2. Navigate to the folder above: + +``` +cd ~/.vim/pack/themes/start +``` + +3. Clone the repository using the "dracula" name: + +``` +git clone https://github.com/dracula/vim.git dracula +``` + +4. Create configuration file (in case you don't have yet): + +``` +touch ~/.vimrc +``` + +5. Edit the `~/.vimrc` file with the following content: + +``` +packadd! dracula +syntax enable +colorscheme dracula +``` + +#### Install using other plugin managers If you [use vim + pathogen](http://vimcasts.org/episodes/synchronizing-plugins-with-git-submodules-and-pathogen/): cd ~/.vim git submodule add git@github.com:dracula/vim.git bundle/dracula -If you [use vim + vundle](https://github.com/gmarik/vundle): +Place `colorscheme dracula` after `execute pathogen#infect()`. + +If you [use vim + vundle](https://github.com/VundleVim/Vundle): Plugin 'dracula/vim', { 'name': 'dracula' } :PluginInstall -If you [use vim-plug](https://github.com/junegunn/vim-plug) (\`as\` will install the plugin in a directory called 'dracula' instead of just 'vim'): +Place `colorscheme dracula` after `call vundle#end()`. + +If you [use vim-plug](https://github.com/junegunn/vim-plug) (\`as\` will install +the plugin in a directory called 'dracula' instead of just 'vim'): Plug 'dracula/vim', { 'as': 'dracula' } :PlugInstall -Note that dracula must be in your `'runtimepath'` to load properly: Version 2.0 introduced autoload functionality for part of the plugin, which doesn't work without `'runtimepath'` properly set. +Place `colorscheme dracula` after `call plug#end()`. -For users of Vim 8's `|packages|` feature, it suffices to put +--- - packadd! dracula - -in your vimrc, alongside `syntax on` and `colorscheme dracula`. For users of other plugin managers, consult your documentation to make sure you put dracula on the `'runtimepath'` before loading it. +Note that dracula must be in your `'runtimepath'` to load properly: Version 2.0 +introduced autoload functionality for part of the plugin, which doesn't work +without `'runtimepath'` properly set. Consult your plugin-managers documentation +to make sure you put dracula on the `'runtimepath'` before loading it. diff --git a/README.md b/README.md index 40603f2..a73807d 100644 --- a/README.md +++ b/README.md @@ -6,24 +6,7 @@ ## Install -All instructions can be found at -[draculatheme.com/vim](https://draculatheme.com/vim). - -Note that dracula must be in your `'runtimepath'` to load properly: Version 2.0 -introduced autoload functionality for part of the plugin, which doesn't work -without `'runtimepath'` properly set. - -For users of Vim 8's `|packages|` feature, it suffices to put - - packadd! {name} - colorscheme dracula - -in your vimrc. `{name}` Should be replaced by the directory you put the code in. -For example, if you use `~/.vim/pack/themes/start/my-dracula-theme`, you would do -`packadd! my-dracula-theme`. - -For users of other plugin managers, consult your documentation -to make sure you put dracula on the `'runtimepath'` before loading it. +All instructions can be found at [draculatheme.com/vim](https://draculatheme.com/vim). ## Team