From 7cc15607878ff08fd3ae120e55a4f6be04df0aa4 Mon Sep 17 00:00:00 2001 From: Fred Pauchet Date: Mon, 14 Sep 2015 21:01:28 +0200 Subject: [PATCH] move readme content to install.md; readme.md is used as an book introduction --- INSTALL.md | 23 +++++++++++++++++++++++ README.md | 13 ------------- 2 files changed, 23 insertions(+), 13 deletions(-) create mode 100644 INSTALL.md diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..a70f2c0 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,23 @@ +# Installation + +## Prérequis + +`sudo aptitude install nodejs`. +Après cela, lance `npm install` qui ira récupérer le contenu du fichier `package.json`. + +## Editeur + +Il existe un éditeur pour Gitbook, qui offre pas mal de fonctionnalités sans avoir à tripatouiller la documentation; il est disponible à [l'adresse suivante](https://www.gitbook.com/editor/linux). + +Pour l'installation, un petit `dpkg -i gitbook-editor.x.y.z.deb`. +Seul soucis: un compte Gitbook est requis. + +# Initialisation + +L'initiation du contenu peut se faire une fois que le module `gitbook-cli`aura été installé, grâce à la commande `nodejs node_modules/gitbook-cli/bin/gitbook.js init `. +Cette commande se base sur le fichier `SUMMARY.md` pour générer l'arborescence correcte des fichiers (vides, dans un premier temps). + +# Compilation + + * `nodejs node_modules/gitbook-cli/bin/gitbook.js build` + * `nodejs node_modules/gitbook-cli/bin/gitbook.js serve` diff --git a/README.md b/README.md index af8b552..e69de29 100644 --- a/README.md +++ b/README.md @@ -1,13 +0,0 @@ -# Installation - -## Prérequis - -`sudo aptitude install nodejs`. -Après cela, lance `npm install` qui ira récupérer le contenu du fichier `package.json`. - -## Editeur - -Il existe un éditeur pour Gitbook, qui offre pas mal de fonctionnalités sans avoir à tripatouiller la documentation; il est disponible à [l'adresse suivante](https://www.gitbook.com/editor/linux). - -Pour l'installation, un petit `dpkg -i gitbook-editor.x.y.z.deb`. -Seul soucis: un compte Gitbook est requis.