expandurl-mastodon/README.md

48 lines
1.2 KiB
Markdown

**expandurl-mastodon** is a Mastodon bot that expands a shortened URL.
If you want the bot to expand an URL, reply to the post with the URL in it and
mention the bot account (@expandurl@botsin.space for example).
# Install
## Dependencies
* Tested OS: Linux
* C++ compiler (tested: gcc 6.4, clang 5.0)
* [cmake](https://cmake.org/) (tested: 3.9.6)
* [curlpp](http://www.curlpp.org/) (tested: 0.8.4)
* [mastodon-cpp](https://github.com/tastytea/mastodon-cpp) (at least: 0.12.1)
## Get sourcecode
### Development version
git clone https://github.com/tastytea/expandurl-mastodon.git
## Compile
mkdir build
cd build/
cmake ..
make
Install with `make install`.
# Usage
You will need to generate an access token yourself at the moment. Create a
config file with your account and access token in
`${HOME}/.config/expandurl-mastodon.cfg`:
expandurl@example.social
abc123
Now start expandurl-mastodon without parameters.
# 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.