From 3dc81ba72ef024283e0244151d46dc122f8d2c1c Mon Sep 17 00:00:00 2001 From: blagoev Date: Wed, 15 Mar 2017 16:25:05 +0200 Subject: [PATCH] update README.md --- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/README.md b/README.md index 4dcfc7a4..7101db0c 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,46 @@ To build for Android: - `./gradlew publishAndroid` - The compiled version of the Android module is here: `/android` +To build for nodejs: + +``` +npm install --build-from-souce +``` + + - On Windows you will need to setup the environment for node-gyp + + - Option 1: Install windows-build-tools node package + + - Open an elevated command prompt (As Administrator) + + ``` + npm install -g --production windows-build-tools + ``` + + * Option 2: Manually install and configure + + - Check [node-gyp](https://github.com/nodejs/node-gyp) manual for custom installation procedure for Windows + + +## Running the tests + +You can use scripts/tests.sh to run the various tests. +You will need yarn installed on the machine. + +test.sh options + + * eslint - lints the sources + * realmjs - runs all tests on quick simulated environment + * react-tests - runs all React Native tests on iOS Simulator + * react-tests-android runs all React Native Android tests on Android emulator + * node - runs all tests for node + * node-nosync - runs all tests for node withouit sync support + * test-runners - checks supported tests runners are working correctly + + + + + ## Code of Conduct This project adheres to the Contributor Covenant [code of conduct](https://realm.io/conduct/).