From e80ce4e9ae0f4b3a85097de0093e24b9e25329e5 Mon Sep 17 00:00:00 2001 From: "Glenn Y. Rolland" Date: Mon, 20 Jun 2022 12:14:42 +0200 Subject: [PATCH] doc: Update README --- README.md | 34 +++++++++++++++------------------- 1 file changed, 15 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index e4d3bfa..a44a4bf 100644 --- a/README.md +++ b/README.md @@ -2,30 +2,26 @@ ## Prerequisites : -Make sure you have python and node 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 - +Make sure you have docker installed ## 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