Commit Graph

9 Commits

Author SHA1 Message Date
Patrice Peterson
354f8da568 Minor capitalization and awkward wording fixes
- Replace all occurences of Jedi-Vim/Jedi with jedi-vim/jedi
- Capitalize first letter on bullet points
- oh god how do i english
- Fix wrong description of g:jedi#auto_close_doc option
2013-03-02 05:17:09 +01:00
Patrice Peterson
31611335b4 Out of beta, yay 2013-03-02 04:58:47 +01:00
Patrice Peterson
a8726171bf Add license section 2013-03-01 21:11:50 +01:00
Patrice Peterson
4c0652064a Added blurb about configuration in .vimrc
I don't know if this should even be in there because it seems kind of
like a bug.
2013-03-01 20:57:04 +01:00
Patrice Peterson
0d27821064 Add usage section and goto/find_def explanation
The usage section feels sort of superfluous. I don't know. >:(

The distinction between jedi#goto() and jedi#fund_definition() was a bit
unclear, so I expanded it a bit.
2013-03-01 20:57:04 +01:00
Patrice Peterson
93e49bb888 Add install, intro, and features sections 2013-03-01 20:57:04 +01:00
Patrice Peterson
84a982ee26 Document keybindings and options
All keybindings and options have at least a short description added to
them.

With this commit the general structure of a Vim help file is in place.
2013-03-01 20:57:04 +01:00
Patrice Peterson
4bc8a44453 Cosmetic and formatting fixes
- Remove images in introduction
- Replace all occurences of VIM with Vim
- Use Vim code blocks
- Surround all keybindings with <>
2013-03-01 20:57:04 +01:00
Patrice Peterson
e6ef96412e Add vimdoc documentation
For now, this is just the README.rst file with appropriate sections. The
content of the file itself is completely unchanged.

Section name suggestions are taken from Steve Losh's Learn Vimscript the
Hard Way [1]. Formatting suggestions are taken from Vim's own
documentation on writing help files (:help help-writing).

The spiffy header was created using the figlet program [2] and the
starwars.flf font found in the figlet fonts database [3].

[1] http://learnvimscriptthehardway.stevelosh.com/chapters/54.html
[2] http://www.figlet.org
[3] http://www.figlet.org/fonts/starwars.flf
2013-03-01 20:57:04 +01:00