0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-24 01:57:32 +01:00
wagtail/docs/getting_started.rst
2014-07-31 10:14:31 +01:00

54 lines
1020 B
ReStructuredText

.. _getting_started:
===============
Getting started
===============
Installing Wagtail
==================
From PyPI
---------
This is recommended for stability.
.. code-block:: bash
pip install wagtail
From Github
-----------
This will give you the latest development version of Wagtail.
.. code-block:: bash
pip install -e git://github.com/torchbox/wagtail.git#egg=wagtail
The ``wagtail-project`` command
===============================
.. versionadded:: 0.5
Once you have Wagtail installed on your host machine, you can use the ``wagtail-project`` command.
Usage:
.. code-block:: bash
wagtail-project <project name>
This command will setup a skeleton Wagtail project with the following features installed:
- A core app with migrations to replace the default Homepage
- Base templates (base, 404, 500)
- Vagrant configuration
- Fabfile
- Docs directory (with Sphinx configuration)
- Split up settings configuration (different settings for dev and production)
- Requirements