Update README.md

This commit is contained in:
Tobias Fella 2020-04-23 12:03:25 +00:00
parent 6e204c6ec9
commit eaa4d41d7c
1 changed files with 31 additions and 1 deletions

View File

@ -1,4 +1,34 @@
# Alligator
Alligator is an RSS/Atom feed reader, currently under development.
Alligator is a convergent RSS/Atom feed reader.
# Building
## Requirements
- KCoreAddons
- KI18n
- KConfig
- Kirigami
- Syndication
## Linux
`git clone https://invent.kde.org/kde/alligator`
`cd alligator`
`mkdir build && cd build`
`cmake .. -DCMAKE_PREFIX_PATH=/usr`
`make`
`sudo make install`
This assumes all dependencies are installed. If your distribution does not provide
them, you can use [kdesrc-build](https://kdesrc-build.kde.org/) to build all of them.
## Android
You can build Alligator for Android using KDE's [Docker-based build environment](https://community.kde.org/Android/Environment_via_Container).