soupbot/README.md

52 lines
1.2 KiB
Markdown
Raw 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 6.4)
* [cmake](https://cmake.org/) (tested: 3.9.6)
* [boost](http://www.boost.org/) (tested: 1.63.0)
2018-06-04 21:06:28 +02:00
* [mastodon-cpp](https://schlomp.space/tastytea/mastodon-cpp) (at least: 0.8.6)
2018-01-22 03:01:32 +01:00
## Get sourcecode
### Development version
2018-06-04 21:06:28 +02:00
git clone https://schlomp.space/tastytea/soupbot.git
2018-01-22 03:01:32 +01:00
## Compile
mkdir build
cd build/
cmake ..
make
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
## Error codes
2018-06-04 21:06:28 +02:00
Same as [mastodon-cpp](https://schlomp.space/tastytea/mastodon-cpp/src/branch/master/README.md#error-codes), plus:
2018-02-28 22:47:29 +01:00
2018-01-22 03:01:32 +01:00
| Code | Explanation |
| --------: |:------------------------------|
2018-02-28 22:47:29 +01:00
| 1 | File not readable |
2018-01-22 03:01:32 +01:00
# Copyright
Copyright © 2018 tastytea <tastytea@tastytea.de>.
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.