Simple templates plugin for Vim

Árni Dagur a79ac3d9e4 code review changes: sanitized file path, make code and documentation consistent 3 months ago
doc f96c65ea98 addressing some issues with licensee integration, allowing for opt-out in configuration 3 months ago
plugin a79ac3d9e4 code review changes: sanitized file path, make code and documentation consistent 3 months ago
syntax e1bc3e1663 syntax error - missing backslash 2 years ago
templates 606d5d419b Add Solidity template 1 year ago
README.rst e069d71bc6 README: Add section about the documentation 1 year ago

README.rst

=============================
Simple Vim templates plugin
=============================
:Author: Adrian Perez

This is a simple plugin for Vim that will allow you to have a set of
templates for certain file types. It is useful to add boilerplate code
like guards in C/C++ headers, or license disclaimers.


Installation
============

The easiest way to install the plugin is to install it as a bundle.
For example, using Pathogen__:

1. Get and install `pathogen.vim `_. You can skip this step
if you already have it installed.

2. ``cd ~/.vim/bundle``

3. ``git clone git://github.com/aperezdc/vim-template.git``

__ https://github.com/tpope/vim-pathogen

Bundle installs are known to work fine also when using Vundle__. Other
bundle managers are expected to work as well.

__ https://github.com/gmarik/vundle


.. important:: If you use Fish__ as your shell, you *will* need to add
``set shell=/bin/sh`` to your ``~/.vimrc`` — the plugin relies on the
setting pointing to a Bourne-compatible__ shell.

__ http://fishshell.com/
__ https://en.wikipedia.org/wiki/Bourne_shell


Documentation
=============

The documentation can be browsed directly in Vim::

:help template.txt

Alternatively, you can also `read it in your browser`__.

__ https://github.com/aperezdc/vim-template/blob/master/doc/template.txt


Updating
========

Manually
--------

In order to update the plugin, go to its bundle directory and use
Git to update it:

1. ``cd ~/.vim/bundle/vim-template``

2. ``git pull``


With Vundle
-----------

Use the ``:BundleUpdate`` command provided by Vundle, for example invoking
Vim like this::

% vim +BundleUpdate