| |
| README - WebM Contributor's Guide |
| ================================= |
| |
| The file `webm-contributor-guide.txt` is the Contributor's Guide source |
| document. It can be easily transformed to HTML5 using kramdown [1] and |
| the included template file, `template.html`. |
| |
| kramdown is a well-maintained text-to-HTML transformer, in Ruby, |
| typically installed via rubygems [2]: |
| |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| # gem install kramdown |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| |
| rubygems should satisfy all dependencies during install. If preferred, |
| Ruby Gems can be installed in userland: |
| |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| $ gem install kramdown |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| |
| To build the HTML5 output: |
| |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| $ kramdown webm-contributor-guide.txt --template template.html > webm-contributor-guide.html |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| |
| |
| [1]: http://kramdown.rubyforge.org/ |
| [2]: http://rubygems.org/ |
| |
| |
| -- |
| Lou Quillio <webmaster@webmproject.org> |
