Skip to content
This repository has been archived by the owner on Nov 26, 2018. It is now read-only.

Docs updates #99

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <desired_nick>

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 <http://www.ietf.org/rfc/rfc1459.txt>`_ 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
Expand Down
8 changes: 4 additions & 4 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -76,7 +76,7 @@ Then, to run all the services defined in ``Procfile``:

.. note:: `foreman <http://ddollar.github.com/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.

Expand All @@ -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
Expand Down