Skip to content

Commit

Permalink
Updated docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
josephbirkner committed May 15, 2019
1 parent d517b35 commit 8c77ac4
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 3 deletions.
21 changes: 19 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,13 @@
Initial configuration and setup
</a>

</li>

<li class="md-nav__item">
<a href="#running-your-telegram-bot" title="Running your Telegram bot" class="md-nav__link">
Running your Telegram bot
</a>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -599,6 +606,13 @@
Initial configuration and setup
</a>

</li>

<li class="md-nav__item">
<a href="#running-your-telegram-bot" title="Running your Telegram bot" class="md-nav__link">
Running your Telegram bot
</a>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -732,7 +746,7 @@

<h1>Home</h1>

<p><a href="https://github.com/ro-boy/ravestate"><img alt="Release" src="https://img.shields.io/github/release/Roboy/ravestate.svg" /></a>
<p><a href="https://github.com/roboy/ravestate"><img alt="Release" src="https://img.shields.io/github/release/Roboy/ravestate.svg" /></a>
<a href="https://travis-ci.org/Roboy/ravestate"><img alt="Build Status" src="https://travis-ci.org/Roboy/ravestate.svg?branch=master" /></a>
<a href="https://codecov.io/gh/Roboy/ravestate"><img alt="codecov" src="https://codecov.io/gh/Roboy/ravestate/branch/master/graph/badge.svg" /></a></p>
<h2 id="about">About</h2>
Expand Down Expand Up @@ -837,7 +851,10 @@ <h4 id="initial-configuration-and-setup">Initial configuration and setup</h4>
</code></pre>

<p>After the conversation, check the Neo4j interface under <code>localhost:7474</code>. It should now contain some nodes!</p>
<p><strong>Reminder: Whenever you use ravestate from the command line, activate the virtual environment first!</strong></p>
<p><strong>Reminder: Whenever you use ravestate from the command line, source the virtual environment first!</strong></p>
<h4 id="running-your-telegram-bot">Running your Telegram bot</h4>
<p>To test your telegram bot with a custom bot token in your <code>keys.yml</code>,
just run <code>telegram_test.yml</code> instead of <code>generic.yml</code>. This will load the <code>ravestate_telegramio</code> module.</p>
<h4 id="setting-up-pycharm">Setting up PyCharm</h4>
<ol>
<li>Open your local ravestate clone as a project in pycharm.</li>
Expand Down
2 changes: 1 addition & 1 deletion docs/search/search_index.json

Large diffs are not rendered by default.

Binary file modified docs/sitemap.xml.gz
Binary file not shown.

0 comments on commit 8c77ac4

Please sign in to comment.