diff --git a/README.md b/README.md index f9c55765a..cb00a44d5 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,10 @@ Please refer to our [Getting Started guide](https://fbsonar.com/docs/getting-sta * iOS developer tools (for developing iOS plugins) * Android SDK and adb -## Starting the desktop app +# Building from Source + +## Desktop +### Running from source ``` git clone https://github.com/facebook/Sonar.git @@ -52,11 +55,26 @@ yarn start NOTE: If you're on Windows, you need to use Yarn 1.5.1 until [this issue](https://github.com/yarnpkg/yarn/issues/6048) is resolved. -## Building the desktop app +### Building standalone application ``` yarn build --mac --version $buildNumber ``` +## iOS SDK + Sample App + +``` +cd iOS/Sample +pod install +open Sample.xcworkspace + +``` + +## Android SDK + Sample app + +Start up an android emulator and run the following in the project root: +``` +./gradlew :sample:installDebug +``` ## Documentation