Fred
/
gwift-book
1
0
Fork 1
Code Issues 64 Pull Requests 3 Releases 11 Wiki Activity

move readme content to install.md; readme.md is used as an book introduction

This commit is contained in:
Fred Pauchet 2015-09-14 21:01:28 +02:00
parent 899dc0b9f0
commit 7cc1560787
2 changed files with 23 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
INSTALL.md Normal file
View File

@ -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 <folder>`.
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`

13
README.md
View File

@ -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.