diff --git a/chatter/README.md b/chatter/README.md index 9be320e..933162a 100644 --- a/chatter/README.md +++ b/chatter/README.md @@ -36,7 +36,7 @@ The sqlite database can be safely deleted at any time. Deletion will only erase # Installation -The installation is currently very tricky, and only tested on a Windows Machine. +The installation is currently very tricky on Windows. There are a number of reasons for this, but the main ones are as follows: * Using a dev version of chatterbot @@ -46,6 +46,8 @@ There are a number of reasons for this, but the main ones are as follows: * C++ Build tools are required on Windows for spaCy * Pandoc is required for something on windows, but I can't remember what +Linux is a bit easier, but only tested on Debian and Ubuntu. + ## Windows Prerequisites Install these on your windows machine before attempting the installation @@ -54,7 +56,7 @@ Install these on your windows machine before attempting the installation [Pandoc - Universal Document Converter](https://pandoc.org/installing.html) -##Methods +## Methods ### Windows - Manually #### Step 1: Built-in Downloader @@ -66,6 +68,8 @@ You need to get a copy of the requirements.txt provided with chatter, I recommen #### Step 2: Install Requirements +Make sure you have your virtual environment that you installed Red on activated before starting this step. See the Red Docs for details on how. + In a terminal running as an admin, navigate to the directory containing this repo. I've used my install directory as an example. @@ -85,7 +89,25 @@ pip install --no-deps "chatterbot>=1.1" ### Linux - Manually -Linux installation has not currently been evaluated, but Ubuntu testing is planned. +#### Step 1: Built-in Downloader + +``` +[p]cog install Chatter +``` + +#### Step 2: Install Requirements + +In your console with your virtual environment activated: + +``` +pip install --no-deps "chatterbot>=1.1" +``` + +### Step 3: Load Chatter + +``` +[p]load chatter +``` # Configuration @@ -148,4 +170,4 @@ settings. This can take a long time to process. Chatter can be configured to use one of three different Similarity algorithms. -Changing this can help if the response speed is too slow, but can reduce the accuracy of results. \ No newline at end of file +Changing this can help if the response speed is too slow, but can reduce the accuracy of results.