Commit 344a0b53 authored by NanoDano's avatar NanoDano

Convert readme to RST and link to documentation

parent b898dae3
# ChattyCathy
Artificial intelligence (AI) chat bot for Discord written in Python
# Project Home Page
Visit the project page on DevDungeon.com for more information.
https://www.devdungeon.com/content/chatty-cathy
# AIML Tutorial
For more details on using AIML with Python, see the tutorial on DevDungeon.
https://www.devdungeon.com/content/ai-chat-bot-python-aiml
# Live Demo
Chat with Chatty Cathy in the DevDungeon Discord server channel #chat-with-cathy.
https://discord.gg/unSddKm
# Set up your own bot
Run your own bot by following the instructions below.
## Installation
pip install cathy
Or download this package and install with setup.py
python setup.py install
## Running
cathy --help
## Usage
Cathy.
Discord chat bot using AIML artificial intelligence
Usage:
cathy <channel> <token>
Options:
<channel> Name of channel to chat in (no hashtag)
<token> Bot's Discord API token
-h --help Show this screen.
## Example Usage
cathy chat-with-cathy XXXXXXSECRETTOKENXXXXXXX
## Contact
nanodano@devdungeon.com
Cathy AI Discord Chat Bot
===========
Artificial intelligence (AI) chat bot for Discord written in Python
.. image:: https://readthedocs.org/projects/cathy-docs/badge/?version=latest
:target: https://cathy-docs.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
Documentation
=============
Read the documentation online at http://cathy-docs.rtfd.io/
Optionally, build the documentation from the ``docs/`` folder::
pip install sphinx
cd docs/
make html
Contact
=======
nanodano@devdungeon.com
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment