diff --git a/README.md b/README.md index 3d7469895d39783bfb29d3d592d26bc54c2fdbd1..d6f727e9beb73078593021f85d427469864d043b 100755 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ -# Generate beautiful word from markdown +# Gazelle User Documentation Generate gazelle framework documentation from markdown files. -This project generates pdf, pdf with revision marks and a static website (using jekyll). +This project generates static website (using jekyll) and PDF documents (oudated). ## Build and preview website with Docker It requires Docker and docker-compose installed. -No local Ruby, Pandoc, tex, ... are required. +No more local Ruby, Pandoc, tex, ... are required. -To update website and serve it : +To update website and serve it (ONLY FOR DEV): ```bash docker-compose up --build @@ -18,54 +18,36 @@ docker-compose up --build Document is then available at <http://localhost:1080/gazelle-documentation/> -## Requirements +## Build without Docker - sudo apt-get install make git git-svn texlive-xetex pandoc ruby-dev +### setup -Clone using git - - mkdir gazelle-user-documentation - cd gazelle-user-documentation - git clone git@gitlab.inria.fr:gazelle/documentation/gazelle-user-documentation.git - -You shall have previously defined your GitLab user: git config --global user.email "email@example.com" - -### Usage of git - -To update your local copy - - git rebase . - -Once your work is ready, you can commit locally - - git add filenames - git commit -m "blah blah" filenames - -And then push all the local commits on Git Lab - - git push - -## Generate documentation - -install required software - -from `gazelle-dev-documentation` folder run: +```bash +sudo apt-get install make git git-svn texlive-xetex pandoc ruby-dev +``` - $ make setup - # will install requirement on the computer +Then, from `gazelle-dev-documentation` folder run to install some more libs and required gems - $ make - # will generate all the documents and the website +```bash +make setup +``` - $ make view - # will generate all the documents and start jekyll +### Generate the documents and the website +```bash +make +``` -from a project folder run: +### Generate all the documents and start Jekyll (do not use in production) +```shell +make view +``` - $ make release-notes - # will generate the PDF version of the release notes +### Generate the PDF version of the release note +```shell +make release-notes +``` -Check target folder for results +Check target/ folder for results ## Folder structure @@ -76,7 +58,7 @@ Check target folder for results | |--Makefile | |--media/ | |--user.md - Â | |--release-notes/ + | |--release-notes/ | | |--1_0_0.md (one file per release, named with version identifier) | |--target/ (Created at compile time) | @@ -85,7 +67,7 @@ Check target folder for results | |--Makefile | |--media/ | |--user.md - Â | |--release-notes/ + | |--release-notes/ | | |--1_0_0.md (one file per release, named with version identifier) | |--target/ (Created at compile time) | @@ -108,7 +90,7 @@ The YAML header is used by Jekyll and pandoc to generate menus and front pages, The YAML header is used by Jekyll and pandoc to generate menus and front pages, make sure all the metadata are present and up-to-date. The *.md files must start with the YAML header. -# Links +## Links http://pandoc.org/