Skip to content

Commit

Permalink
Improve installation documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
NoUseFreak committed Mar 20, 2015
1 parent 058b982 commit 8d220c5
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion docs/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,20 @@ If you get an error, remove the word 'php' in front of the line. This depends on

.. code-block:: bash
php composer create-project clastic/standard-edition path/to/install -s dev
$ composer create-project clastic/standard-edition path/to/install -s dev
.. note::

If the installation fails, check if the ``composer`` executable works. You might need to
use ``php composer.phar create-project path/to/install -s dev`` if you installed composer locally.

During the installation you will be asked to fill in some parameters. Make sure all the values are correct.

You should now have a project located in ``path/to/install``. Please go to this folder and continue.

.. code-block:: bash
$ cd path/to/install
Clastic needs multiple assets to be installed in the correct place. The standard project contains a `Makefile`
to simplify this process.
Expand All @@ -39,6 +49,13 @@ to simplify this process.
make install
.. note::

Now is a good time to have a first commit!

Development
-----------

You can now start your developement environment.

.. code-block:: bash
Expand Down

0 comments on commit 8d220c5

Please sign in to comment.