Updated README
This commit is contained in:
parent
78f5b73bf2
commit
af92780b5a
1 changed files with 4 additions and 18 deletions
22
README.md
22
README.md
|
@ -1,32 +1,18 @@
|
|||
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
|
||||
|
||||
Debug mode:
|
||||
|
||||
```shell
|
||||
npm run build
|
||||
./gradlew assembleDebug
|
||||
# APK generated under app/build/outputs/apk/debug/app-debug.apk
|
||||
```
|
||||
|
||||
Release mode:
|
||||
|
||||
```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/`.
|
||||
|
||||
|
|
Loading…
Reference in a new issue