From 97c068cda14ecef80713a42d6545550014647753 Mon Sep 17 00:00:00 2001
From: erichard <elliot.richard@lal.in2p3.fr>
Date: Wed, 22 Jul 2020 09:42:16 +0200
Subject: [PATCH] add copy of labelstower's master README.md

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/README.md b/README.md
index cb0eefd..8951be8 100644
--- a/README.md
+++ b/README.md
@@ -20,3 +20,25 @@ run the application
 
     ./run_dev.sh
 
+# Code Guards
+
+Some python code for management of user accounts within a Flask application.
+
+## Directories
+
+Most directories have their own `README.md`.
+* `codeguards` : main code, i.e. a blueprint for Flask.
+* `docker` : anything for building docker images with all the needed externals.
+* `dist` : where we build and store wheel distributions of the main codeguards code.
+* `test/instance` : where we initialize a test sqlite database.
+* `test/demo_blog` : web demo application.
+* `test/scripts` : various command-line test.
+
+## Demonstration from scratch, with Docker
+
+With the help of Docker :
+1. Build the dev Docker image : `docker/build_externals.sh`
+1. Build the codeguards distribution : `docker/run_externals.sh dist/build.sh`
+1. Build the demo Docker image : `docker/build_latest.sh` (it includes the above distribution)
+1. Initialize a database : `docker/run_latest.sh instance/init_db.sh`
+1. Starts the flask server : `docker/run_latest.sh`
-- 
GitLab