soupbot/README.md

50 lines
1021 B
Markdown
Raw Permalink Normal View History

**soupbot** is a soup-recommending bot for Mastodon.
2018-01-22 03:01:32 +01:00
# Install
## Dependencies
* Tested OS: Linux
* C++ compiler (tested: gcc 9)
* [cmake](https://cmake.org/) (tested: 3.16)
* [boost](http://www.boost.org/) (tested: 1.72)
* [mastodonpp](https://schlomp.space/tastytea/mastodonpp) (at least: 0.5.5)
2018-01-22 03:01:32 +01:00
## Get sourcecode
### Development version
2019-04-21 16:42:28 +02:00
``` shellsession
git clone https://schlomp.space/tastytea/soupbot.git
```
2018-01-22 03:01:32 +01:00
## Compile
2019-04-21 16:42:28 +02:00
``` shellsession
mkdir build
cd build/
cmake ..
make
```
2018-01-22 03:01:32 +01:00
cmake options:
* `-DCMAKE_BUILD_TYPE=Debug` for a debug build
Install with `make install`.
# Usage
Copy `ingredients.json` to `~/.config/soupbot/ingredients.json`.
You will need a pre-generated authentication code.
2018-01-22 03:01:32 +01:00
# Copyright
2019-04-21 16:42:28 +02:00
``` text
Copyright © 2018, 2019, 2020 tastytea <tastytea@tastytea.de>.
2019-04-21 16:42:28 +02:00
License GPLv3: GNU GPL version 3 <https://www.gnu.org/licenses/gpl-3.0.html>.
This program comes with ABSOLUTELY NO WARRANTY. This is free software,
and you are welcome to redistribute it under certain conditions.
```