Add template README
This won't be correct until we publish.
This commit is contained in:
parent
c907912a16
commit
f9ea32573e
64
README.md
Normal file
64
README.md
Normal file
|
@ -0,0 +1,64 @@
|
|||
# Swiper
|
||||
|
||||
Watch multiple videos on your Android device back-to-back.
|
||||
<br />
|
||||
<br />
|
||||
<img src="https://img.shields.io/f-droid/v/com.swiper.svg?logo=F-Droid" />
|
||||
|
||||
<a href="https://play.google.com/store/apps/details?id=com.swiper">
|
||||
<img height="75" alt="Get it on Google Play"
|
||||
src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png"/>
|
||||
</a>
|
||||
<a href="https://f-droid.org/en/packages/com.swiper">
|
||||
<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" height="75">
|
||||
</a>
|
||||
|
||||
# Screenshots
|
||||
|
||||
<img src="metadata/en-US/images/phoneScreenshots/home.png" width="318"/>
|
||||
<img src="metadata/en-US/images/phoneScreenshots/edit.png" width="318"/>
|
||||
|
||||
# Building from Source
|
||||
|
||||
First follow the [React Native Environment Setup](https://reactnative.dev/docs/environment-setup).
|
||||
Then run the following command:
|
||||
|
||||
```sh
|
||||
cd android
|
||||
./gradlew assembleRelease
|
||||
```
|
||||
|
||||
The apk file can be found at
|
||||
`android/app/build/outputs/apk/release/app-*-release.apk`
|
||||
The APKs are separated by architecture, for example we have:
|
||||
- `app-arm64-v8a-release.apk`
|
||||
- `app-armeabi-v7a-release.apk`
|
||||
- `app-x86_64-release.apk`
|
||||
- `app-x86-release.apk`
|
||||
|
||||
Your phone is probably `app-arm64-v8a-release.apk`.
|
||||
|
||||
# Running in Development
|
||||
|
||||
First ensure Node.js dependencies are installed:
|
||||
|
||||
```
|
||||
yarn install
|
||||
```
|
||||
|
||||
Then start the metro server:
|
||||
|
||||
```
|
||||
yarn start
|
||||
```
|
||||
|
||||
Then (in a separate terminal) run the `android` script:
|
||||
|
||||
```
|
||||
yarn android
|
||||
```
|
||||
|
||||
# Fdroid Metadata
|
||||
|
||||
You can find the metadata yaml file in the fdroiddata repository:
|
||||
https://gitlab.com/fdroid/fdroiddata/-/blob/master/metadata/com.swiper.yml
|
Loading…
Reference in New Issue
Block a user