annotate README.markdown @ 5:3a4f9f41a7e2

Use a hackish shortcut to get the current branch faster for the statusline.
author Ludovic Chabant <ludovic@chabant.com>
date Thu, 08 Dec 2011 21:12:04 -0800
parents fc4a778325d4
children c3958d29878e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
1
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
2 Lawrencium
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
3 ==========
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
4
3
fc4a778325d4 Fixed links in README.
Ludovic Chabant <ludovic@chabant.com>
parents: 2
diff changeset
5 Lawrencium is a [Mercurial][] wrapper for [Vim][], inspired by Tim Pope's [Fugitive][].
2
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
6
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
7
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
8 Disclaimer
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
9 ----------
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
10
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
11 This plugin is still very young, and it's also the very first one I've ever written -- I'm basically learning Vim as I go along, so bear with me. Comments and help are all welcome.
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
12
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
13
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
14 Installation
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
15 ------------
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
16
3
fc4a778325d4 Fixed links in README.
Ludovic Chabant <ludovic@chabant.com>
parents: 2
diff changeset
17 The recommended method to install Lawrencium is to use [Pathogen][], also from Tim Pope:
2
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
18
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
19 cd ~/.vim/bundle
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
20 hg clone https://bitbucket.org/ludovicchabant/lawrencium
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
21
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
22 You can then update the help tags with `:call pathogen#helptags()` and browse Lawrencium's help pages with `:help lawrencium`.
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
23
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
24
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
25 [mercurial]: http://hg-scm.com
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
26 [vim]: http://www.vim.org
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
27 [fugitive]: https://github.com/tpope/vim-fugitive
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
28 [pathogen]: https://github.com/tpope/vim-pathogen
c9eb66aff5cb Added a README file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
29