Mercurial > vim-lawrencium
annotate README.markdown @ 151:59c51f0d6008
Fix indenting
| author | Ludovic Chabant <ludovic@chabant.com> |
|---|---|
| date | Mon, 08 Nov 2021 10:35:02 -0800 |
| parents | f9abc2e2aa90 |
| children | e52c62ac52fc |
| rev | line source |
|---|---|
| 2 | 1 |
| 2 Lawrencium | |
| 3 ========== | |
| 4 | |
| 3 | 5 Lawrencium is a [Mercurial][] wrapper for [Vim][], inspired by Tim Pope's [Fugitive][]. |
| 2 | 6 |
| 7 | |
| 8 Installation | |
| 9 ------------ | |
| 10 | |
| 3 | 11 The recommended method to install Lawrencium is to use [Pathogen][], also from Tim Pope: |
| 2 | 12 |
| 13 cd ~/.vim/bundle | |
|
36
f9abc2e2aa90
Fixed incorrect URL in README.
Ludovic Chabant <ludovic@chabant.com>
parents:
35
diff
changeset
|
14 hg clone https://bitbucket.org/ludovicchabant/vim-lawrencium |
| 2 | 15 |
| 16 You can then update the help tags with `:call pathogen#helptags()` and browse Lawrencium's help pages with `:help lawrencium`. | |
| 17 | |
| 18 | |
| 35 | 19 Quick Start |
| 20 ----------- | |
| 21 | |
| 22 Open a file from one of your Mercurial repositories. | |
| 23 | |
| 24 :e ~/Work/Project1/src/foo.py | |
| 25 | |
| 26 Work on it for a bit, then open another file, this time using `Hgedit` and a | |
| 27 repository-relative path: | |
| 28 | |
| 29 :Hgedit src/bar.py | |
| 30 | |
| 31 Take advantage of the auto-completion when typing the path! Work on that | |
| 32 other file too, then compare it to the parent revision version: | |
| 33 | |
| 34 :Hgvdiff | |
| 35 | |
| 36 Continue working. At any moment, you can run a Mercurial command and get a | |
| 37 quick glance at its output: | |
| 38 | |
| 39 :Hg log --limit 5 src/blah/bleh | |
| 40 | |
| 41 Note how auto-completion will help you with all the built-in commands and | |
| 42 their options! Any other parameter will auto-complete with repository-relative | |
| 43 paths. | |
| 44 | |
| 45 Once you're happy with your work, bring up the status window: | |
| 46 | |
| 47 :Hgstatus | |
| 48 | |
| 49 You can see the difference between modified files and their parent revision | |
| 50 version easily by moving the cursor to the appropriate line and hitting | |
| 51 <C-V>. You can also do an `addremove` by using <C-A> (use the selection mode | |
| 52 to add/remove several files at once!). | |
| 53 | |
| 54 Now it's time to commit. While still in the status window, remove all mentions | |
| 55 of files you don't want to commit, and hit <C-S>. Write your commit message, | |
| 56 go `:wq`, and you're done! You can check everything went fine: | |
| 57 | |
| 58 :Hg tip | |
| 59 | |
| 60 You can also commit faster with the `:Hgcommit` command of course! | |
| 61 | |
| 62 And that's it for now. Open the help file with `:help lawrencium`, and post | |
| 63 your questions and problems in the [issue tracker][1] on BitBucket. | |
| 64 | |
| 65 | |
| 2 | 66 [mercurial]: http://hg-scm.com |
| 67 [vim]: http://www.vim.org | |
| 68 [fugitive]: https://github.com/tpope/vim-fugitive | |
| 69 [pathogen]: https://github.com/tpope/vim-pathogen | |
| 35 | 70 [1]: https://bitbucket.org/ludovicchabant/vim-lawrencium/issues |
| 2 | 71 |