Updated documentation.

This commit is contained in:
tastytea 2019-04-21 16:42:28 +02:00
parent c8b123da05
commit 57e391d605
Signed by: tastytea
GPG Key ID: CFC39497F1B26E07
2 changed files with 23 additions and 15 deletions

View File

@ -5,23 +5,27 @@
## Dependencies ## Dependencies
* Tested OS: Linux * Tested OS: Linux
* C++ compiler (tested: gcc 6.4) * C++ compiler (tested: gcc 8)
* [cmake](https://cmake.org/) (tested: 3.9.6) * [cmake](https://cmake.org/) (tested: 3.9)
* [boost](http://www.boost.org/) (tested: 1.63.0) * [boost](http://www.boost.org/) (tested: 1.65)
* [mastodon-cpp](https://schlomp.space/tastytea/mastodon-cpp) (at least: 0.8.6) * [mastodon-cpp](https://schlomp.space/tastytea/mastodon-cpp) (at least: 0.105.0)
## Get sourcecode ## Get sourcecode
### Development version ### Development version
git clone https://schlomp.space/tastytea/soupbot.git ``` shellsession
git clone https://schlomp.space/tastytea/soupbot.git
```
## Compile ## Compile
mkdir build ``` shellsession
cd build/ mkdir build
cmake .. cd build/
make cmake ..
make
```
cmake options: cmake options:
@ -37,7 +41,9 @@ You will need a pre-generated authentication code.
## Error codes ## Error codes
Same as [mastodon-cpp](https://schlomp.space/tastytea/mastodon-cpp/src/branch/master/README.md#error-codes), plus: Same as
[mastodon-cpp](https://schlomp.space/tastytea/mastodon-cpp/src/branch/master/README.md#error-codes),
plus:
| Code | Explanation | | Code | Explanation |
| --------: |:------------------------------| | --------: |:------------------------------|
@ -45,7 +51,9 @@ Same as [mastodon-cpp](https://schlomp.space/tastytea/mastodon-cpp/src/branch/ma
# Copyright # Copyright
Copyright © 2018 tastytea <tastytea@tastytea.de>. ``` text
License GPLv3: GNU GPL version 3 <https://www.gnu.org/licenses/gpl-3.0.html>. Copyright © 2018, 2019 tastytea <tastytea@tastytea.de>.
This program comes with ABSOLUTELY NO WARRANTY. This is free software, License GPLv3: GNU GPL version 3 <https://www.gnu.org/licenses/gpl-3.0.html>.
and you are welcome to redistribute it under certain conditions. This program comes with ABSOLUTELY NO WARRANTY. This is free software,
and you are welcome to redistribute it under certain conditions.
```

View File

@ -1,5 +1,5 @@
/* This file is part of soupbot. /* This file is part of soupbot.
* Copyright © 2018 tastytea <tastytea@tastytea.de> * Copyright © 2018, 2019 tastytea <tastytea@tastytea.de>
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by