Lemmy
/
lemmur-app-android
mirror of https://github.com/krawieck/lemmur/
1
0
Fork 0
Code Issues Releases Wiki Activity

Update readme

This commit is contained in:
shilangyu 2021-04-06 14:22:19 +02:00
parent 9b725d8a02
commit 031a087e8f
1 changed files with 20 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -6,7 +6,11 @@
# lemmur
A mobile client for [lemmy](https://github.com/LemmyNet/lemmy) - a federated reddit alternative
[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" alt="Get it on F-Droid" height="80">](https://f-droid.org/packages/com.krawieck.lemmur)
[<img src="https://cdn.rawgit.com/steverichey/google-play-badge-svg/master/img/en_get.svg" height="80">](https://play.google.com/store/apps/details?id=com.krawieck.lemmur)
[<img src="https://raw.githubusercontent.com/andOTP/andOTP/master/assets/badges/get-it-on-github.png" height="80">](https://github.com/krawieck/lemmur/releases/latest)
A mobile client for [Lemmy](https://github.com/LemmyNet/lemmy) - a federated reddit alternative
<a href="https://www.buymeacoffee.com/lemmur" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>
@ -18,6 +22,9 @@ A mobile client for [lemmy](https://github.com/LemmyNet/lemmy) - a federated red
- [Android](#android)
- [Linux](#linux)
- [Windows](#windows)
- [FAQ](#faq)
- [Version x.x.x was released, why is it not yet on F-droid?](#version-xxx-was-released-why-is-it-not-yet-on-f-droid)
- ["App not installed" - what to do?](#app-not-installed---what-to-do)
## Build from source
@ -36,10 +43,8 @@ The apk will be in `build/app/outputs/flutter-apk/app-release.apk`
### Linux
1. Make sure you have the additional [linux requirements](https://flutter.dev/desktop#additional-linux-requirements) (verify with `flutter doctor`)
2. Switch to dev channel of flutter:
2. Enable linux desktop:
```sh
flutter channel dev
flutter upgrade
flutter config --enable-linux-desktop
```
3. Build: `flutter build linux`
@ -49,12 +54,20 @@ The executable will be in `build/linux/release/bundle/lemmur` (be aware, however
### Windows
1. Make sure you have the additional [windows requirements](https://flutter.dev/desktop#additional-windows-requirements) (verify with `flutter doctor`)
2. Switch to dev channel of flutter:
2. Enable windows desktop:
```sh
flutter channel dev
flutter upgrade
flutter config --enable-windows-desktop
```
3. Build: `flutter build windows`
The executable will be in `build\windows\runner\Release\lemmur.exe` (be aware, however, that this executable is not standalone)
## FAQ
### Version x.x.x was released, why is it not yet on F-droid?
We have no control over F-droid's build process. This process is automatic and not always predictable in terms of time it takes. If a new version does not appear in F-droid a week after its release, then feel free to open an issue about it and we will look into it.
### "App not installed" - what to do?
When installing the APK directly you might get this message. This happens when you are trying to update lemmur from a different source than where you originally got it from. To fix it simply uninstall the previous version (you will lose all local data) and then install the new one. Always make sure to install lemmur APKs only from verified sources.