tastytea
/
whyblocked
1
0
Fork 0
Code Issues 4 Pull Requests Releases 23 Wiki Activity

Added documentation

This commit is contained in:
tastytea 2018-08-30 14:30:55 +02:00
parent 05c601021d
commit 1f15ef0253
Signed by: tastytea
GPG Key ID: CFC39497F1B26E07
1 changed files with 37 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -2,3 +2,40 @@
Mastodon in mind, but can be used for other contexts, of course.
It has a text interface and uses a SQLite-database.
## Usage
```PLAIN
$ whyblocked
This is whyblock 0.1.0.
Type add, remove, view or details. Or just the first letter.
: v
Blocked: @baduser@social.example.com because: Is very mean
Silenced: @truebelievers.example.com because: Annoying instance
: d
Which user?
@baduser@social.example.com
@baduser@social.example.com is blocked, because: Is very mean
Receipts:
https:///social.example.com/@baduser/123456789012345678
: q
```
## Install
### Dependencies
* C++ compiler (tested: gcc 6/7/8)
* [cmake](https://cmake.org/) (at least 3.7)
* [vsqlite++](http://vsqlite.virtuosic-bytes.com/) (tested: 0.3.13)
* [libxdg-basedir](http://repo.or.cz/w/libxdg-basedir.git) (tested: 1.2)
### Compile
```SH
mkdir build
cd build
cmake ..
make
make install
```