writing docs

comodojo · Dec 23, 2015 · b830505 · b830505
1 parent 03db35d
commit b830505
Show file tree

Hide file tree

Showing 6 changed files with 74 additions and 4 deletions.
diff --git a/docs/_static/comodojo_logo.png b/docs/_static/comodojo_logo.png
diff --git a/docs/applications.rst b/docs/applications.rst
@@ -0,0 +1,4 @@
+Applicaions Model
+=================
+
+(Page yet to be written)
diff --git a/docs/authentication.rst b/docs/authentication.rst
@@ -0,0 +1,4 @@
+Authentication
+==============
+
+(Page yet to be written)
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,20 +3,39 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to The Comodojo Framework's documentation!
-==================================================
+The Comodojo Framework's docs
+=============================
+
+.. image:: _static/comodojo_logo.png
+
+Comodojo is a PHP/js framework that provides a complete environment to
+realize complex and easy-to-maintain web applications.
+
+Instead of offer a common foundation classes to biuld a single web app, Comodojo
+aims to be a pre-built environment where:
+
+- a couple of logical releated function (or even a single one) can be realized by an application;
+- an application publishes routes both on a server and client side, defining state-aware, linkable locations;
+- applications can (and generally should) be deployed, updated, removed using composer; in addition, multiple applications can be packaged under the same composer package;
+- internal role-mapper provides the connection between users and applications, exposing to user only the routes it should reach.
+
+.. warning:: Code is under active development, there is no stable release and it may change without notice at any time.
+
+.. note:: If you're interested in participating development, please send a message to marco.giovinazzi@comodojo.org.
 
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
-
+   status
+   installation
+   authentication
+   applications
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -0,0 +1,28 @@
+Install Comodojo
+================
+
+.. _comodojo: https://github.com/comodojo/comodojo
+.. _composer: https://getcomposer.org/
+.. _comodojo/comodojo.installer: https://github.com/comodojo/comodojo.installer
+.. _comodojo/comodojo: https://github.com/comodojo/comodojo
+
+Comodojo can be installed via `composer`_, using `comodojo/comodojo`_ project's package.
+
+Requirements
+************
+
+To work properly, comodojo requires an apache webserver (nginx will also be supported ) with PHP >=5.6.0.
+
+Installing via composer
+***********************
+
+.. warning:: This procedure is not complete, unstable, untested. In other words, there are no chances it will work.
+
+At the time of writing, the `comodojo/comodojo.installer`_ plugin should be installed
+first as global package, then a new comodojo/comodojo project can be created with:
+
+    composer create-project comodojo/comodojo myinstallationpath
+
+The web root of your server shoud point to myinstallationpath/public.
+
+More details will come in near future.
diff --git a/docs/status.rst b/docs/status.rst
@@ -0,0 +1,15 @@
+Project Status
+==============
+
+.. _packagist: https://packagist.org/packages/comodojo/
+.. _comodojo website: https://comodojo.org
+.. _dispatcher: https://dispatcher.comodojo.org
+.. _extender: https://extender.comodojo.org
+
+The framework is still in a pre-alpha stage and there is no planned release date yet.
+
+Code will be published on `packagist`_ as soon as an alpha release is available.
+
+Many of the foundation libraries are already stable and released under MIT license
+(refer to `comodojo website`_ for a complete list) as well as the two microframework
+`dispatcher`_ and `extender`_.