network/alligator/README.md

0001 # Alligator
0002
0003 Alligator is a convergent RSS/Atom feed reader.
0004
0005 <a href='https://flathub.org/apps/details/org.kde.alligator'><img width='190px' alt='Download on Flathub' src='https://flathub.org/assets/badges/flathub-badge-i-en.png'/></a>
0006
0007 ![Screnshot of a feed](https://cdn.kde.org/screenshots/alligator/alligator-desktop.png)
0008
0009 ## Get It
0010
0011 Details on where to find stable releases of Alligator can be found on its
0012 [homepage](https://apps.kde.org/alligator). Nightly Android APKs are available at [KDE's Binary Factory](https://kfunk.org/2017/11/17/kde-binary-factory/):
0013 - [Android ARM](https://binary-factory.kde.org/view/Android/job/Alligator_Nightly_android-arm/)
0014 - [Android ARM64](https://binary-factory.kde.org/view/Android/job/Alligator_Nightly_android-arm64/)
0015 - [Android x86](https://binary-factory.kde.org/view/Android/job/Alligator_Nightly_android-x86/)
0016 - [Android x86_64](https://binary-factory.kde.org/view/Android/job/Alligator_Nightly_android-x86_64/)
0017
0018 ## Building
0019
0020 Note: When using versions of alligator built from git-master, it's possible that the database format or the name of downloaded files change from one version to another without the necessary migrations to handle it. If you notice bugs after upgrading to a git-master version, export your feeds, delete `~/.local/share/KDE/alligator` and import the feeds again.
0021
0022 ### Requirements
0023  - KCoreAddons
0024  - KI18n
0025  - KConfig
0026  - Kirigami
0027  - Syndication
0028
0029 ### Linux
0030
0031 ```
0032 git clone https://invent.kde.org/plasma-mobile/alligator
0033 cd alligator
0034 mkdir build && cd  build
0035 cmake .. -DCMAKE_PREFIX_PATH=/usr
0036 make
0037 sudo make install
0038 ```
0039
0040 This assumes all dependencies are installed. If your distribution does not provide
0041 them, you can use [kdesrc-build](https://kdesrc-build.kde.org/) to build all of them.
0042
0043 ### Android
0044
0045 You can build Alligator for Android using KDE's [Docker-based build environment](https://community.kde.org/Android/Environment_via_Container).
0046