From c3eba86911fa91639d9e07b80ee8d1c91f4c2eef Mon Sep 17 00:00:00 2001
From: Miguel Barão <mjsb@uevora.pt>
Date: Thu, 11 Apr 2019 20:18:39 +0100
Subject: [PATCH] update README.md

---
 README.md | 41 ++++++++++++++++++-----------------------
 1 file changed, 18 insertions(+), 23 deletions(-)

diff --git a/README.md b/README.md
index bdf9a4e..3514844 100644
--- a/README.md
+++ b/README.md
@@ -3,18 +3,18 @@
 
 ## Requirements
 
-Before installing the server, we will need to install python with some additional packages.
+Before installing the server, we will need to install python3.7 with some additional packages, and npm (Node package management).
 
-### Install python3.7 with sqlite3 support
+### Install python3.7 with sqlite3 support and npm
 
 This can be done using the system package management, downloaded from [http://www.python.org](), or compiled from sources.
 
 - Installing from the system package manager:
 
 ```sh
-sudo port install python37                # MacOS
-sudo pkg install python37 py37-sqlite3    # FreeBSD
-sudo apt install ?not available yet?      # Linux, install from source
+sudo port install python37 npm5              # MacOS
+sudo pkg install python37 py37-sqlite3 npm   # FreeBSD
+sudo apt install python3.7 npm               # Linux
 ```
 
 - Installing from source:
@@ -50,33 +50,27 @@ If you want to always install python modules on the user account (recommended), 
 user = yes
 ```
 
-### Install additional python packages:
+### Install python packages and javascript libraries:
+
+Replace USER by your bitbucket username:
 
 ```sh
-pip3 install --user \
-    tornado \
-    sqlalchemy \
-    pyyaml \
-    pygments \
-    mistune \
-    bcrypt \
-    networkx
+cd path/to/some/directory
+git clone https://USER@bitbucket.org/mjsb/aprendizations.git
+cd aprendizations
+pip install .           # install aprendizations and dependencies
+npm install             # install javascript libraries
 ```
 
-These are usually installed under
+Python packages are usually installed in:
 
 - `~/.local/lib/python3.7/site-packages/` in Linux/FreeBSD.
 - `~/Library/python/3.7/lib/python/site-packages/` in MacOS.
 
-## Installation
-
-Replace USER by your bitbucket username:
+Javascript libraries are installed in `aprendizations/node_modules` directory.
+This libraries are linked from the `aprendizations/aprendizations/static` directory.
 
-```sh
-cd path/to/some/directory
-git clone https://USER@bitbucket.org/mjsb/aprendizations.git
-cd aprendizations
-```
+At this point aprendizations can be run anywhere with the command `aprendizations`.
 
 ## Configuration
 
@@ -87,6 +81,7 @@ The user data is maintained in a sqlite3 database file. We first need to create 
 ```sh
 cd aprendizations
 ./initdb.py                 # show current database or initialize empty if nonexisting
+./initdb.py --admin         # add admin user
 ./initdb.py inscricoes.csv  # add students from CSV, passwords are the numbers
 ./initdb.py --add 1184 "Aladino da Silva"   # add new user (default password=1184)
 ./initdb.py --update 1184 --pw alibaba      # update password of given student
--
libgit2 0.21.2