kasts/README.md

# Alligator

Alligator is a convergent RSS/Atom feed reader.

# Get it

Nightly Android APKs are available at [KDE's Binary Factory](https://binary-factory.kde.org/view/Android/job/Alligator_android/).

# Building

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.

## Requirements
 - KCoreAddons
 - KI18n
 - KConfig
 - Kirigami
 - Syndication

## Linux

```
git clone https://invent.kde.org/plasma-mobile/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).
Initial Commit 2020-02-28 23:25:08 +01:00			`# Alligator`

Update README.md 2020-04-23 14:03:25 +02:00			`Alligator is a convergent RSS/Atom feed reader.`

Add link to Binary Factory 2020-04-27 01:08:01 +02:00			`# Get it`

			`Nightly Android APKs are available at [KDE's Binary Factory](https://binary-factory.kde.org/view/Android/job/Alligator_android/).`

Update README.md 2020-04-23 14:03:25 +02:00			`# Building`

Update README.md 2020-09-17 20:55:34 +02:00			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.

Update README.md 2020-04-23 14:03:25 +02:00			`## Requirements`
			`- KCoreAddons`
			`- KI18n`
			`- KConfig`
			`- Kirigami`
			`- Syndication`

			`## Linux`

Use single code-block 2020-04-23 14:43:50 +02:00			```
Update url to new location 2020-05-18 14:36:48 +02:00			`git clone https://invent.kde.org/plasma-mobile/alligator`
Use single code-block 2020-04-23 14:43:50 +02:00			`cd alligator`
			`mkdir build && cd build`
			`cmake .. -DCMAKE_PREFIX_PATH=/usr`
			`make`
			`sudo make install`
			```
Update README.md 2020-04-23 14:03:25 +02:00
			`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).`
Initial Commit 2020-02-28 23:25:08 +01:00