Commit graph

34 commits

Author SHA1 Message Date
Mislav Marohnić
da562ad74c replace build system with generated table of contents
Gets rid of `doc/README.mdtoc` and its build script. Since GitHub.com
renders anchors for each heading, all we have to do is put a simple
table of contents into `README.md` itself, and everything will get
linked up nicely.

Pros of this approach:
* We don't have to point out to people not to edit `README.md` anymore
* We don't have to run the build script each time README gets edited

Cons of this change:
* The "chapter" numbers are lost. They were silly anyway.

`doc/mdtoc` renders a Markdown table of contents for a Markdown file.
`doc/filter-toc` filters that down to only headings after ToC.
This script can be used to easily insert ToC into the current document
when editing `README.md` with, e.g., Vim:

    :read !doc/filter-toc %
2012-12-12 23:06:44 +01:00
Javier Candeira
7f1aefa09b fix install instructions for ubuntu (using version 12.04, but should work for all versions) 2012-12-12 16:15:28 +11:00
Guillermo Iguaran
2a347226df Merge pull request #225 from dentarg/master
Fixed broken link to RVM in documentation
2012-12-11 13:19:53 -08:00
Ryan Bigg
962452d6d1 Merge pull request #188 from tundramonkey/master
Added in short note on Uninstalling Rubies under new 2.4 section in README
2012-12-11 13:13:44 -08:00
Guillermo Iguaran
2df165c49e Sync doc/README.mdtoc with the actual README
All the changes to documentation should be done in doc/README.mdtoc
2012-12-11 16:06:02 -05:00
Patrik Ragnarsson
406c8e0303 Fixed broken link to RVM in documentation 2012-05-12 22:38:56 +02:00
Daryl Manning
5e57ab95ce Changed doc/README.mdtoc and built README.md and changed nomenclature to 'ruby versions' as requested. 2012-02-09 16:20:53 +11:00
Jussi Virtanen
34813ef32c Fix typos in documentation 2012-01-29 11:35:01 +02:00
Sam Stephenson
b10bdb1e78 rbenv 0.3.0 2011-12-25 21:32:48 -05:00
Sam Stephenson
5052a4161c Update readme screenshot to use global instead of set-default (fixes #165) 2011-12-25 16:53:59 -05:00
Sam Stephenson
4cc6665d0a Zsh users need to modify ~/.zshenv, not ~/.zshrc 2011-11-14 12:52:10 -06:00
Sam Stephenson
01a0ad0b69 rbenv 0.2.1 2011-10-01 12:26:19 -05:00
Sam Stephenson
2bbe2099eb Missing word 2011-10-01 12:20:58 -05:00
Sam Stephenson
fb0ec9e157 Be explicit about ~ 2011-10-01 11:05:31 -05:00
Sam Stephenson
7a929b8a84 Indentation 2011-09-28 13:41:10 -05:00
Sam Stephenson
2cd12e3fa6 rbenv 0.2.0 2011-09-28 13:38:03 -05:00
Sam Stephenson
4965a1d1f7 Style 2011-09-28 13:35:17 -05:00
Sam Stephenson
dc1f583903 "Zsh" is the canonical capitalization 2011-09-28 13:29:37 -05:00
Sam Stephenson
500c6de37c fill-region 2011-09-28 13:27:42 -05:00
Joshua Peek
88e59647ae Installation edits 2011-09-28 13:05:29 -05:00
Sam Stephenson
53d45707ca Add Homebrew to the readme 2011-09-28 12:19:47 -05:00
Sam Stephenson
828051e651 Move intro line above the fold 2011-09-28 12:19:46 -05:00
Sam Stephenson
4712db8edd Add version history 2011-09-28 12:01:44 -05:00
Sam Stephenson
26a08c6d12 Add upgrade instructions 2011-09-28 11:20:15 -05:00
Sam Stephenson
09d912895f Fix markdown indentation 2011-09-28 10:51:09 -05:00
Sam Stephenson
ada26ab92e Document rbenv which and rbenv whence 2011-09-28 10:48:04 -05:00
Sam Stephenson
a3d3005859 Document rbenv shell 2011-09-28 10:13:28 -05:00
Sam Stephenson
aade3ad781 Sync mdtoc source 2011-08-18 15:53:48 -05:00
Sam Stephenson
e43a2039a5 Sync mdtoc source 2011-08-14 13:48:41 -05:00
Sam Stephenson
dfe9889327 Fix ruby-build link 2011-08-11 14:41:24 -05:00
Sam Stephenson
192dc23998 Try a different image url 2011-08-11 14:29:52 -05:00
Sam Stephenson
6c468d6166 Don't highlight the anchors 2011-08-11 14:26:53 -05:00
Sam Stephenson
bfa71017ae Add TOC header 2011-08-11 14:25:08 -05:00
Sam Stephenson
066d63c0df Use mdtoc for the readme 2011-08-11 14:21:15 -05:00