Updated README

This commit is contained in:
Fabio Manganiello 2021-04-28 02:03:01 +02:00
parent 78f5b73bf2
commit af92780b5a

View file

@ -1,32 +1,18 @@
This repository contains the source for the Platypush mobile app. As of now only Android is supported. This repository contains the source for the Platypush mobile app. As of now only Android is supported.
## Requirements
To build the app you'll need `npm` and Android.JS Builder installed on your system:
```shell
[sudo] npm install -g androidjs-builder
```
Then install the JS requirements through `npm` from the repository root directory:
```shell
npm install
```
## Build ## Build
Debug mode: Debug mode:
```shell ```shell
npm run build ./gradlew assembleDebug
# APK generated under app/build/outputs/apk/debug/app-debug.apk
``` ```
Release mode: Release mode:
```shell ```shell
npm run build:release ./gradlew assembleRelease
# APK generated under app/build/outputs/apk/release/app-release-unsigned.apk
``` ```
The generated `.apk` file will be stored under `dist/`.