Mercurial > vim-lawrencium

changeset 2:c9eb66aff5cb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added a README file.
author Ludovic Chabant <ludovic@chabant.com>
date Thu, 08 Dec 2011 13:03:12 -0800
parents 9241ae881b9f
children fc4a778325d4
files README.markdown
diffstat 1 files changed, 29 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.markdown	Thu Dec 08 13:03:12 2011 -0800
@@ -0,0 +1,29 @@
+
+Lawrencium
+==========
+
+Lawrencium is a [Mercurial] wrapper for [Vim], inspired by Tim Pope's [Fugitive].
+
+
+Disclaimer
+----------
+
+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.
+
+
+Installation
+------------
+
+The recommended method to install Lawrencium is to use [Pathogen], also from Tim Pope:
+
+    cd ~/.vim/bundle
+    hg clone https://bitbucket.org/ludovicchabant/lawrencium
+
+You can then update the help tags with `:call pathogen#helptags()` and browse Lawrencium's help pages with `:help lawrencium`.
+
+
+  [mercurial]: http://hg-scm.com
+  [vim]: http://www.vim.org
+  [fugitive]: https://github.com/tpope/vim-fugitive
+  [pathogen]: https://github.com/tpope/vim-pathogen
+