From b678576b8cac3c162655e82dd24d8f271a7299d7 Mon Sep 17 00:00:00 2001 From: array-in-a-matrix Date: Mon, 15 Aug 2022 20:00:17 -0400 Subject: [PATCH] actual instructions REAL --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5ac1b69..b9e6b9d 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,22 @@ Matrix bot that generates messages based off of messages of other users using a neural network. -## Development setup +## Usage + +First install the needed [libraries](#setup). Then copy `example.config.json` and rename it `config.json`. Replace the items in angled brackets with their respective values of the bot account (e.g. replace `` with the homeserver url like `https://matrix.org` or `https://arrayinamatrix.xyz`). You can follow the instructions [here](https://matrix.org/docs/guides/usage-of-matrix-bot-sdk#instantiation) to obtain the token of an account. + +Once the config file has been populated with valid data, execute the `index.js` file (Warning: executing for the first time will be slow.). + +```sh +$ node index.js +... + +... +Client has started! + +``` + +## Setup The project is split into 2 parts `index.js` and `textgen.py`. The `index.js` file contains the code that interacts with the user on Matrix and grabs text generated by the `textgen.py` file.