Add README.md

README.md

@@ -0,0 +1,49 @@
+NotePost App
+============
+
+This is a client app for NotePost.  It has some offline capabilities and can be
+built for most platforms by using [Apache Cordova](https://cordova.apache.org)
+for mobile devices or [NW.js](https://nwjs.io) for PCs.
+
+Platform Support
+----------------
+
+Tested and should work on:
+* Android 5+ (up-to-date WebView implementation required)
+* Linux (amd64 and i386)
+
+Not tested but should work on:
+* Raspberry Pi (using a custom build of NW.js like
+  [this one](https://github.com/jalbam/nwjs_rpi))
+* Windows
+* MacOS (we don't currently offer Mac builds, see below)
+
+There are no official builds for Mac for a few reasons: we don't own any Mac
+computers; Mac builds are about 4x the size of the other builds; and the best
+Mac build we could get working on a Linux build server was a ZIP file.  If you
+want official Mac builds, you'll need to write a working Jenkins build script.
+
+If you want an iOS build, donate $100 for an Apple Developer account.  The
+framework this app uses has an iOS stylesheet, so it'll even look native.
+
+
+Building for NW.js
+------------------
+
+Since this is a webapp, there isn't really a build process.
+
+1. Install [Yarn](https://yarnpkg.com), and run `./yarninstall.sh` to grab dependencies.
+2. Get [NW.js](https://nwjs.io) and unpack it into a folder (we'll use `~/nw.js`).
+3. Move to the `www` folder in this repository and run `~/nw.js/nw .`
+4. The process is basically the same for other OSes, just use the appropriate
+version of NW.js.
+
+Building for Cordova/Android
+----------------------------
+
+This assumes you have Cordova and a working Android SDK installed.
+
+1. Install [Yarn](https://yarnpkg.com), and run `./yarninstall.sh` to grab dependencies.
+2. Run `./removebloat.sh` to cut the APK size in half.
+3. Run `cordova platform add android`.
+4. Run `cordova build android --release`.