From ba131363f3fb213e2f60c684d5d57c7b51f69859 Mon Sep 17 00:00:00 2001 From: Brian Luft Date: Fri, 12 Sep 2014 17:24:55 -0700 Subject: [PATCH 1/2] Use honcho for invoking commands --- docs/install.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/install.rst b/docs/install.rst index 9e8a8d5..8701c70 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -57,10 +57,10 @@ Run in a terminal: createdb botbot echo "create extension hstore" | psql botbot - manage.py syncdb --migrate + honcho run manage.py syncdb --migrate # You'll need a staff account for creating a bot and registering channels - manage.py createsuperuser + honcho run manage.py createsuperuser Redis needs to be running prior to starting the BotBot services. For example: @@ -76,7 +76,7 @@ Then, to run all the services defined in ``Procfile``: .. note:: `foreman `_ will also work if you have the gem or Heroku toolbelt installed. -You should now be able to access the site at ``http://localhost:8000``. Log in with the username you created. +You should now be able to access the site at ``http://localhost:8000``. See :doc:`getting_started` for instructions on configuring a bot. @@ -92,7 +92,7 @@ The tests can currently be run with the following command: .. code-block:: bash - manage.py test accounts bots logs plugins + honcho manage.py test Building Documentation From 5dbfdcdc0b9affa156643ffd54ac820bb48db91a Mon Sep 17 00:00:00 2001 From: Brian Luft Date: Fri, 12 Sep 2014 17:25:19 -0700 Subject: [PATCH 2/2] Updates bot/channel admin based on latest changes --- docs/getting_started.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 9b344df..80f29d2 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -31,8 +31,8 @@ A bot acts as an IRC client. It connects to one or more IRC servers and joins on /msg NickServ info 6. **Real Name:** This should be a readable identifier related to your bot: a URL, project name, etc. The spec leaves a lot of room for interpretation about what this value should be. It could probably be any random value but other members of the Freenode community would likely appreciate if you use a sensible name. See **4.1.3 User message** in the `IRC protocol spec `_ for more info. - -7. **Save** the Bot. Check the output in the console you started ``honcho`` in. You should see a number of messages indicating the bot has connected to Freenode and identified itself. +7. **Slug:** Enter a slug value for the Bot. +8. **Save** the Bot. Add a Channel