actual instructions REAL
This commit is contained in:
parent
885bba8f9b
commit
b678576b8c
1 changed files with 16 additions and 1 deletions
17
README.md
17
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 `<DOMAIN.TLD>` 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
|
||||
...
|
||||
<node warnings, ignore them>
|
||||
...
|
||||
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.
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue