Skip to content

Commit

Permalink
Update installation instructions
Browse files Browse the repository at this point in the history 
This leaves Vim's native package manager as the default, while still
allowing for alternate package managers.

Fixes #297.
  • Loading branch information
@ajzafar
ajzafar committed Dec 29, 2023
1 parent 074fe09 commit febc3c6
Showing 1 changed file with 15 additions and 27 deletions.
42 changes: 15 additions & 27 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,38 +17,26 @@ Garbas][garbas], [Marc Weber][marcweber], and [Adnan Zafar][ajzafar].

## Installing SnipMate ##

We recommend one of the following methods for installing SnipMate and its
dependencies. SnipMate depends on [vim-addon-mw-utils][mw-utils] and
[tlib][tlib].
SnipMate can be installed using a package manager or using Vim's built-in
package handling. It does depend on [vim-addon-mw-utils][mw-utils] and
[tlib][tlib]. For example, to use Vim's built-in support,

> **NOTE:** SnipMate does not ship with any snippets out of the box. We suggest
looking at the [vim-snippets][vim-snippets] repository.

* Using [VAM][vam], add `vim-snippets` to the list of packages to be installed.

* Using [Pathogen][pathogen], run the following commands:

% cd ~/.vim/bundle
% git clone https://github.com/tomtom/tlib_vim.git
% git clone https://github.com/MarcWeber/vim-addon-mw-utils.git
% git clone https://github.com/garbas/vim-snipmate.git
% mkdir -p ~/.vim/pack/SnipMate/start
% git clone https://github.com/tomtom/tlib_vim.git
% git clone https://github.com/MarcWeber/vim-addon-mw-utils.git
% git clone https://github.com/tomtom/tlib_vim.git

# Optional:
% git clone https://github.com/honza/vim-snippets.git
# Optional:
% git clone https://github.com/honza/vim-snippets.git

* Using [Vundle][vundle], add the following to your `vimrc` then run
`:PluginInstall`

Plugin 'MarcWeber/vim-addon-mw-utils'
Plugin 'tomtom/tlib_vim'
Plugin 'garbas/vim-snipmate'

" Optional:
Plugin 'honza/vim-snippets'
> **NOTE:** SnipMate does not ship with any snippets out of the box. We suggest
looking at the [vim-snippets][vim-snippets] repository.

## Using SnipMate ##
Press <tab> and try :SnipMateOpenSnippetFiles for starting.
Also see doc/SnipMate.txt to learn all SnipMate

Install and create some snippets (see `:h SnipMate-snippets`). Then type in the
trigger for one in the correct filetype and hit the expansion key (by default
bound to `<Tab>`).

## FAQ ##

Expand Down

2 comments on commit febc3c6

@h3xx
Copy link

@h3xx h3xx commented on febc3c6 Dec 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Clones https://github.com/tomtom/tlib_vim.git twice
  • Git clone instructions result in creating directories in the current directory, not under ~/.vim/pack/SnipMate/start. Suggest:
mkdir -p ~/.vim/pack/SnipMate/start
cd ~/.vim/pack/SnipMate/start                                            (added)
git clone https://github.com/tomtom/tlib_vim.git
git clone https://github.com/MarcWeber/vim-addon-mw-utils.git
git clone https://github.com/garbas/vim-snipmate.git                     (replaced tlib_vim clone with vim-snipmate clone)

@ajzafar
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@h3xx Thanks for letting me know! The most recent push, a373bce, fixes those mistakes.

Please sign in to comment.