Updated documentation.
This commit is contained in:
parent
c8b123da05
commit
57e391d605
20
README.md
20
README.md
|
@ -5,23 +5,27 @@
|
|||
## 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)
|
||||
* [mastodon-cpp](https://schlomp.space/tastytea/mastodon-cpp) (at least: 0.8.6)
|
||||
* C++ compiler (tested: gcc 8)
|
||||
* [cmake](https://cmake.org/) (tested: 3.9)
|
||||
* [boost](http://www.boost.org/) (tested: 1.65)
|
||||
* [mastodon-cpp](https://schlomp.space/tastytea/mastodon-cpp) (at least: 0.105.0)
|
||||
|
||||
## Get sourcecode
|
||||
|
||||
### Development version
|
||||
|
||||
``` shellsession
|
||||
git clone https://schlomp.space/tastytea/soupbot.git
|
||||
```
|
||||
|
||||
## Compile
|
||||
|
||||
``` shellsession
|
||||
mkdir build
|
||||
cd build/
|
||||
cmake ..
|
||||
make
|
||||
```
|
||||
|
||||
cmake options:
|
||||
|
||||
|
@ -37,7 +41,9 @@ You will need a pre-generated authentication code.
|
|||
|
||||
## 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 |
|
||||
| --------: |:------------------------------|
|
||||
|
@ -45,7 +51,9 @@ Same as [mastodon-cpp](https://schlomp.space/tastytea/mastodon-cpp/src/branch/ma
|
|||
|
||||
# Copyright
|
||||
|
||||
Copyright © 2018 tastytea <tastytea@tastytea.de>.
|
||||
``` text
|
||||
Copyright © 2018, 2019 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.
|
||||
```
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
/* 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
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
|
|
Loading…
Reference in New Issue