lemmur-app-android/README.md

40 lines
1.3 KiB
Markdown
Raw Normal View History

2020-08-02 13:34:42 +02:00
# lemmur
2020-08-02 19:28:42 +02:00
[![](https://github.com/krawieck/lemmur/workflows/ci/badge.svg)](https://github.com/krawieck/lemmur/actions)
[![style: effective dart](https://img.shields.io/badge/style-effective_dart-40c4ff.svg)](https://pub.dev/packages/effective_dart)
2020-08-02 19:28:42 +02:00
2020-08-02 13:54:50 +02:00
A lemmy mobile client
2020-10-20 20:09:58 +02:00
2020-10-25 13:31:19 +01:00
- [lemmur](#lemmur)
- [Build from source](#build-from-source)
- [Prerequisites](#prerequisites)
- [Android](#android)
- [Linux](#linux)
2020-10-20 20:09:58 +02:00
2020-10-25 13:31:19 +01:00
## Build from source
2020-10-20 20:09:58 +02:00
2020-10-25 13:31:19 +01:00
### Prerequisites
2020-10-20 20:09:58 +02:00
2020-10-25 13:31:19 +01:00
- Install [flutter](https://flutter.dev/docs/get-started/install): To check if this step was successful run `flutter doctor` (Installing android studio is not required if you setup the android SDK yourself)
- Clone this repo: `git clone https://github.com/krawieck/lemmur`
- Enter the repo: `cd lemmur`
2020-10-20 20:09:58 +02:00
2020-10-25 13:31:19 +01:00
### Android
1. Build: `flutter build apk`
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)
2. Switch to dev channel of flutter:
```sh
flutter channel dev
flutter upgrade
flutter config --enable-linux-desktop
```
3. Build: `flutter build linux`
The executable will be in `build/linux/release/bundle/lemmur` (be aware, however, that this executable is not standalone)