diff --git a/README.md b/README.md index d6f727e9beb73078593021f85d427469864d043b..9d7e1bc339095fea3cbd1bd07e6c39fae50778f0 100755 --- a/README.md +++ b/README.md @@ -23,10 +23,10 @@ Document is then available at <http://localhost:1080/gazelle-documentation/> ### setup ```bash -sudo apt-get install make git git-svn texlive-xetex pandoc ruby-dev +sudo apt-get install make git git-svn texlive-xetex pandoc ruby-dev build-essential dh-autoreconf ``` -Then, from `gazelle-dev-documentation` folder run to install some more libs and required gems +Then, from `gazelle-dev-documentation` folder run to install some more libs and required gems ```bash make setup @@ -37,18 +37,22 @@ make setup make ``` -### Generate all the documents and start Jekyll (do not use in production) -```shell -make view -``` -### Generate the PDF version of the release note -```shell -make release-notes +### Add a gem in the bundle +```bash +cd target/jekyll-gazelle-documentation +sudo bundle add webrick +sudo bundle install + + ``` -Check target/ folder for results +### Generate all the documents and start Jekyll (do not use in production) +```bash +sudo bundle exec jekyll serve +``` +Once it is done you server must have been started on localhost:4000/gazelle-documentation/ ## Folder structure gazelle-documentation @@ -96,4 +100,3 @@ http://pandoc.org/ [Pandoc installation package](https://github.com/jgm/pandoc/releases/tag/1.17.2) -http://blog.cigrainger.com/2014/07/pandoc-markdown.html