doc: Update README

This commit is contained in:
Glenn Y. Rolland 2022-06-20 12:14:42 +02:00
parent bdff1bff17
commit e80ce4e9ae

View file

@ -2,30 +2,26 @@
## Prerequisites : ## Prerequisites :
Make sure you have python and node installed Make sure you have docker installed
git remote rename origin boilerplate
git remote add origin git@...
git checkout -b upstream/boilerplate/master --track
Install python packages
pip install -U pipenv
pipenv install
Install node packages
npm install
## Usage ## Usage
### First steps ### Create your directory tree
Clean this repository ```
. # project directory
|- docs # where website documents go
| `- *.md
|- slides # where presentation documents go
| `- *.md
|- images/ # where images go
|- ...
```
Change the remote ### Write content for docs
### Write content for slides
### Watch mode ### Watch mode