diff --git a/README.md b/README.md index b4ab5226..2be0d5c9 100644 --- a/README.md +++ b/README.md @@ -13,23 +13,6 @@ Please note that **only the first step** is covered by this gem — the rest hap Please see our [contributing guidelines](CONTRIBUTING.md) before reporting an issue. -Markups -------- - -The following markups are supported. The dependencies listed are required if -you wish to run the library. You can also run `script/bootstrap` to fetch them all. - -* [.markdown, .mdown, .mkdn, .md](http://daringfireball.net/projects/markdown/) -- `gem install commonmarker` (https://github.com/gjtorikian/commonmarker) -* [.textile](https://www.promptworks.com/textile) -- `gem install RedCloth` (https://github.com/jgarber/redcloth) -* [.rdoc](https://ruby.github.io/rdoc/) -- `gem install rdoc -v 3.6.1` -* [.org](http://orgmode.org/) -- `gem install org-ruby` (https://github.com/wallyqs/org-ruby) -* [.creole](http://wikicreole.org/) -- `gem install creole` (https://github.com/larsch/creole) -* [.mediawiki, .wiki](http://www.mediawiki.org/wiki/Help:Formatting) -- `gem install wikicloth` (https://github.com/nricciar/wikicloth) -* [.rst](http://docutils.sourceforge.net/rst.html) -- `pip install docutils` -* [.asciidoc, .adoc, .asc](http://asciidoc.org/) -- `gem install asciidoctor` (http://asciidoctor.org) -* [.pod](http://search.cpan.org/dist/perl/pod/perlpod.pod) -- `Pod::Simple::XHTML` - comes with Perl >= 5.10. Lower versions should install Pod::Simple from CPAN. - Installation ----------- @@ -65,6 +48,47 @@ require 'github/markup' GitHub::Markup.render_s(GitHub::Markups::MARKUP_MARKDOWN, "* One\n* Two") ``` +Building +------- + +1. Ruby 2.3+ and its development headers are required: + + CentOS, Fedora, or RHEL: + + `yum install ruby-devel rubygems` + + Debian: + + `sudo apt-get install ruby-dev` + + Ubuntu: + + `sudo apt-get install ruby-all-dev` + + +2. Run Rake in the root project directory: + + `rake` + +3. Sit back and enjoy a refreshing Diet Coke. + + +Markups +------- + +The following markups are supported. The dependencies listed are required if you wish to run the library. +You can also run `sudo script/bootstrap` to fetch them all (requires ruby dev headers). + +* [.markdown, .mdown, .mkdn, .md](http://daringfireball.net/projects/markdown/) -- `gem install commonmarker` (https://github.com/gjtorikian/commonmarker) +* [.textile](https://www.promptworks.com/textile) -- `gem install RedCloth` (https://github.com/jgarber/redcloth) +* [.rdoc](https://ruby.github.io/rdoc/) -- `gem install rdoc -v 3.6.1` +* [.org](http://orgmode.org/) -- `gem install org-ruby` (https://github.com/wallyqs/org-ruby) +* [.creole](http://wikicreole.org/) -- `gem install creole` (https://github.com/larsch/creole) +* [.mediawiki, .wiki](http://www.mediawiki.org/wiki/Help:Formatting) -- `gem install wikicloth` (https://github.com/nricciar/wikicloth) +* [.rst](http://docutils.sourceforge.net/rst.html) -- `pip install docutils` +* [.asciidoc, .adoc, .asc](http://asciidoc.org/) -- `gem install asciidoctor` (http://asciidoctor.org) +* [.pod](http://search.cpan.org/dist/perl/pod/perlpod.pod) -- `Pod::Simple::XHTML` + comes with Perl >= 5.10. Lower versions should install Pod::Simple from CPAN. Contributing ------------