tuskar-ui/horizon/README
Gabriel Hurley a17570110f Unified horizon and openstack-dashboard environments.
Buildout has been removed entirely, all dev installation is now
done via the single tools/install_venv.py script.

Django's manage.py script has also been updated to a newer
version/convention; this allows for less python path mangling
and makes things cleaner and more explicit. Note that, as such,
it has been moved up a directory level.

Change-Id: I62f9f06ee00568fc91e5ba7e1fd15d22ea849d1f
2012-01-05 13:57:07 -08:00

31 lines
1.1 KiB
Plaintext

========================================
Horizon: The OpenStack Dashboard Project
========================================
The Horizon project is a Django module that is used to provide web based
interactions with an OpenStack cloud.
There is a reference implementation that uses this module located at:
http://launchpad.net/horizon
It is highly recommended that you make use of this reference implementation
so that changes you make can be visualized effectively and are consistent.
Using this reference implementation as a development environment will greatly
simplify development of the ``horizon`` module.
Of course, if you are developing your own Django site using Horizon, then
you can disregard this advice.
Getting Started
===============
Horizon uses the common environment configured by ``tools/install_venv.py``
based on the dependencies listed in ``tools/pip-requires`` for local
development.
The simplest way to get going is to simply run the ``run_tests.sh`` script
included with the Horizon project. This will set up your local environment
and run the full test suite to verify that everything is working properly.