Update readme

README.md

@@ -2,34 +2,34 @@
 
 Python webpy application running on uswgi server with nginx using docker connected to another docker-runned mysql database.
 
-Web Server image: https://github.com/tiangolo/uwsgi-nginx-docker
-webpy framework: http://webpy.org/
-
-
-## Prerequisites:
-
-Docker https://www.docker.com/
+Web Server image base: https://github.com/tiangolo/uwsgi-nginx-docker
 
-IMPORTANT Windows users use:
-> git clone --repositoryURL-- --config core.autocrlf=input
-
-On linux docker is started with
+webpy framework: http://webpy.org/
 
-$ sudo systemctl start docker
 
-To run docker-compose without sudo the user must be added to the usergroup:
+## Installation:
 
-https://docs.docker.com/install/linux/linux-postinstall/
+1. Install docker: https://www.docker.com/
+2. Install docker-compose: https://docs.docker.com/compose/install/
+3. Launch docker
+4. Clone this repository:
+> git clone \<repositoryURL\>
 
-## Run
+IMPORTANT Windows users must use:
+> git clone \<repositoryURL\> --config core.autocrlf=input
+5. Run the application:
+> docker-compose up
 
-$ docker-compose up
+6. The application should become available on URL:
+http://0.0.0.0:80\<groupid\> <br>
+Or if you are running docker-toolbox :
+http://192.168.99.100:80\<groupid\>
 
 ### Build / Rebuild
 
 Upon changes in the code the docker image must be built again for the changes to take effect. Some changes might not get reflected even on build, which is when the --force-recreate attribute can be used.
 
-$ docker-compose up --build --force-recreate
+$ docker-compose up --build 
 
 ### Prune / Recreate
 If you need a completely fresh rebuild (WARNING this will remove all your docker images). This will reset the images including the database which is not necessary affected by only rebuilding the images
@@ -38,19 +38,23 @@ $ docker system prune -a
 
 $ docker-compose up
 
-# Deploy locally
+### Config
 
-Running the application outside of containers might be useful for development because the images does not need to be rebuilt for every change in the code.
+The ip and ports for the web server and database is set with the .env file using the groupid variable.
+
+## Deploy locally
 
-## Prerequisites:
+Running the application outside of containers might be useful for development because the images does not need to be rebuilt for every change in the code. This is optional.
 
-mysql
+### Prerequisites:
 
-python 3.6.8 or higher
+mysql server
 
-src/app/requirements.txt
+python =< 3.6.8
 
-## Run Datatbase:
+python packages: src/app/requirements.txt
+
+### Run Datatbase:
 
 Launch mysql at default port (3306)
 
@@ -70,11 +74,9 @@ SET PASSWORD FOR 'root'@'localhost' = PASSWORD('root');
 
 GRANT ALL PRIVILEGES ON db.* TO 'root'@'localhost';
 
-
 Then populate databse by posting mysql/sql/init.sql into mysql
 
-
-## Run app
+### Run app
 
 Edit src/app/models/database.py to point at local database server
 
@@ -82,6 +84,3 @@ $ cd src/app/
 
 $ python3 src/app/main.py
 
-# Config
-
-The ip and ports for the web server and database is set with the .env file using the groupid variable.