Skip to content

Commit

Permalink
Update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
mzilinec committed Jun 7, 2019
1 parent 8ea86ef commit 5f6cec5
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
3 changes: 3 additions & 0 deletions docs/quickstart/actions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,9 @@ Read more in `Scheduling messages`_.
.. TODO explain payloads
Amazing, you're now ready to implement your first action. But wait, the chatbot does not yet understand anything the user said, what about that?
Continue reading and you'll find out in `Natural language processing`.

-------------------
Message templates
-------------------
Expand Down
14 changes: 13 additions & 1 deletion docs/quickstart/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ Installation
| First, install Botshot and dependencies from PyPI.
| ``pip3 install botshot``
|
| You will also need to install and start the Redis database. On Ubuntu, run:
| ``sudo apt install redis-server``
|
| Now go ahead and run:
| ``bots init my_bot``
| This will bootstrap a chatbot with default configuration under ``my_bot/``.
Expand All @@ -26,6 +29,15 @@ Running the chatbot
| The web chat interface should now be running at http://127.0.0.1:8000/ .
| Go ahead and trying sending a message to your chatbot!

+++++++++++++++++++++++++++
Windows support
+++++++++++++++++++++++++++

Install Botshot on Windows Subsystem for Linux (WSL). This was tested on Windows 10 1903 build. Follow the [instalation guide](https://docs.microsoft.com/cs-cz/windows/wsl/install-win10) if you haven't installed WSL yet.

Running Botshot on Windows natively is not supported yet.

+++++++++++++++++++++++++++
Running from IDE (optional)
+++++++++++++++++++++++++++
Expand All @@ -43,4 +55,4 @@ You will need to manually start the required components:
- Redis database
| You can either run ``redis-server`` from the terminal or with an init script, as you would any other database.
| If you're on Ubuntu and have installed redis with ``apt install redis``, it should already be running.
| You can connect to your database using ``redis-cli``.
| You can connect to your database using ``redis-cli``.

0 comments on commit 5f6cec5

Please sign in to comment.