Browse Source

update readme

Carsten Porth 5 years ago
parent
commit
ea61d6373d
1 changed files with 21 additions and 2 deletions
  1. 21 2
      app/README.md

+ 21 - 2
app/README.md

@@ -1,4 +1,23 @@
-# How to run the app
+# HybridOSN
+
+## Getting started
+
+- Install NodeJs
+- Set up Cordova and Ionic
+- Clone this repository
+- Install dependencies `npm i`
+
+## How to build and run the app
 
 Run on Android emulator: `ionic cordova emulate android`
-Run on connected Android device: `ionic cordova run android`
+Run on connected Android device: `ionic cordova run android`
+
+## Known Problems
+
+In case the build process fails with the error
+
+```
+Execution failed for task ':app:transformDexArchiveWithExternalLibsDexMergerForDebug'.
+```
+
+run `cordova clean`