diff --git a/README.rst b/README.rst index 7997b4deef60ee69afc148c02b5a6d420ccc2bd5..265ad27898508d65a9647edd6f20d426981090c6 100644 --- a/README.rst +++ b/README.rst @@ -105,7 +105,7 @@ Documentation Our documentation project is divided in 3 parts. The user guide is the only one which is automatically built as part of the ``buildout`` procedure. The API and -administrators guide needs to be manually compiled if required. +administrators guide need to be manually compiled if required. To build the API documentation, just do:: @@ -142,7 +142,8 @@ For a simple (development) web server, the default settings on working directory * Run with full debug output * It sets the working BEAT prefix to ``./prefix`` - * A single user, called ``admin`` will be setup into the system + * A single user, called ``user`` (password ``user``) will be setup into the + system If you need to tweak these settings, just edit the file ``beat/web/settings/settings.py``. You may consult the `Django documentation`_ @@ -240,9 +241,9 @@ Now start the localhost system:: You may inspect this programs help message for details on its usage and options. -Once the localhost system is started and the scheduler is properly configured, -you may open a browser window to your `localhost, port 8000 -<http://127.0.0.1:8000>`_, to get started with your locally installed platform. +Once the localhost system is started you may open a browser window to your +`localhost, port 8000 <http://127.0.0.1:8000>`_, to get started with your +locally installed platform. Localhost with ``DEBUG=False`` @@ -255,35 +256,19 @@ development server with slightly different settings:: $ ./bin/localhost.py -v --settings=beat.web.settings.nodebug -Triggering a Scheduler Reconfiguration -====================================== - -If you modify the queue configuration on the Django administrative panel, -you'll need to notify the scheduler of those changes. You can trigger a -scheduler (hot) re-configuration using the following command-line program:: - - $ ./bin/django qconf - -.. note:: - - Optionally, you may also visit `your local scheduler page - <http://127.0.0.1:8000/backend/scheduler>`, and hit the (green) button that - says "Send configuration to Scheduler". It has the same effect. - - Unit Testing ------------ After installation, it is possible to run our suite of unit tests. To do so, use:: - $ ./bin/django test --settings=beat.web.settings.test -v 2 + $ ./bin/django test --settings=beat.web.settings.test -v 1 You may pass filtering criteria to just launch tests for a particular set of ``beat.web`` applications. For example, to run tests only concerning ``beat.web.toolchains``, run:: - $ ./bin/django test --settings=beat.web.settings.test -v 2 beat.web.toolchains.tests + $ ./bin/django test --settings=beat.web.settings.test -v 1 beat.web.toolchains.tests To measure coverage, you must set an environment variable for nose:: @@ -300,7 +285,7 @@ Or, to generate an HTML report:: database from run to run. In order to do this, just specify the flag ``--keepdb`` when you run your tests:: - $ ./bin/django test --settings=beat.web.settings.test -v 2 --keepdb + $ ./bin/django test --settings=beat.web.settings.test -v 1 --keepdb In this case, Django will create and keep a test database called ``test.sql3`` on your current directory. You may delete it when you're done.