Fixes documentation

README.md

@@ -107,11 +107,13 @@ Following the installation documentation below, you'll be able to run your own i
 
 # Installation #
 
-## Debian dependencies ##
+## Distribution dependencies ##
 
 You'll need to install the following packages :
 
-    sudo apt install git realpath python3 python-virtualenv python3-dev python-pip build-essential libxml2-dev libxslt1-dev python-lxml zlib1g-dev redis-server
+    sudo apt install git realpath redis-server \
+                     python3 python-virtualenv python3-dev python-pip  python-lxml \
+                     build-essential libxml2-dev libxslt1-dev zlib1g-dev
 
 ## Get the source ##
 
@@ -166,13 +168,21 @@ Create configuration files for a development environment and for `WsgiDAV`:
     cp tracim/development.ini.base tracim/development.ini
     cp tracim/wsgidav.conf.sample tracim/wsgidav.conf
 
-## database schema ##
+## Database schema ##
 
 The last step before running the application is to initialize the database
 schema. This is done through the following command:
 
     cd tracim && gearbox setup-app && cd -
 
+## Running the paste http server ##
+
+    gearbox serve
+
+While developing, the following command may be more convenient:
+
+    gearbox serve --reload --debug
+
 ## Running the standalone server ##
 
 Now you can run the standalone server:
@@ -200,6 +210,14 @@ If admin user not created yet, execute following command:
 
 Enjoy :)
 
+# Going further #
+
+Here is additional documentation about configuring:
+
+ * [Apache](doc/apache.md)
+ * [PostgreSQL, MySQL and SQLAlchemy](doc/database.md)
+ * [Tracim](doc/setting.md)
+
 # Support and Community #
 
 Building the community is a work in progress.

doc/database.md

@@ -3,7 +3,7 @@
 
 ## PostgreSQL ##
 
-If you want use `PostgreSQL` as database engine:
+If you want to use `PostgreSQL` as database engine:
 
     sudo apt install postgresql-server-dev-all postgresql postgresql-client
 
@@ -13,7 +13,7 @@ If you already use/know `PostgreSQL`, you can directly go to *Test the database
 
 #### Driver ####
 
-Tracim uses the `psycopg` driver between the `SQLAlchemy` ORM and the `PostgreSQL` RDBMS. Run the following command to install the right version:
+Tracim uses the `psycopg2` driver between the `SQLAlchemy` ORM and the `PostgreSQL` RDBMS. Run the following command to install the right version:
 
     pip install -r install/requirements.postgresql.txt
 

tracim/README.txt

@@ -1,24 +0,0 @@
-This file is for you to describe the pod application. Typically
-you would include information such as the information below:
-
-Installation and Setup
-======================
-
-Install ``pod`` using the setup.py script::
-
-    $ cd pod
-    $ python setup.py develop
-
-Create the project database for any model classes defined::
-
-    $ gearbox setup-app
-
-Start the paste http server::
-
-    $ gearbox serve
-
-While developing you may want the server to reload after changes in package files (or its dependencies) are saved. This can be achieved easily by adding the --reload option::
-
-    $ gearbox serve --reload --debug
-
-Then you are ready to go.