Commit 26600055ae629a73f6bdd6109246e5b305eb3f81
dx: update CONTRIBUTING.md
David Gomez committed on 6/13/2020, 6:15:49 PMParent: 51708b51a02ec18c58f13e41a1acdf9f8cdde4f7
Files changed
| CONTRIBUTING.md | changed |
| CONTRIBUTING.md | ||
|---|---|---|
| @@ -13,22 +13,22 @@ | ||
| 13 | 13 | ### Development OS |
| 14 | 14 | |
| 15 | 15 | - If your target OS is **iOS**, only **macOS** computers are supported |
| 16 | 16 | - If your target OS is **Android**, only **Linux and macOS** computers are supported |
| 17 | - - *No Windows support* so far, unfortunately; but you can always choose to install Linux for free if you have a Windows computer | |
| 17 | + - _No Windows support_ so far, unfortunately; but you can always choose to install Linux for free if you have a Windows computer | |
| 18 | 18 | |
| 19 | 19 | ### macOS specifics |
| 20 | 20 | |
| 21 | -If you are developing on a macOS computer, then you might need `realpath`, install it through coreutils: | |
| 21 | +If you are developing on a macOS computer, then you might need `realpath`, install it through coreutils and some additional `node-sodium` compilation dependencies: | |
| 22 | 22 | |
| 23 | 23 | ``` |
| 24 | 24 | brew update |
| 25 | -brew install coreutils | |
| 25 | +brew install coreutils libtool autoconf automake | |
| 26 | 26 | ``` |
| 27 | 27 | |
| 28 | 28 | ### Node.js |
| 29 | 29 | |
| 30 | -Use node (preferably exactly) `12.16.x` and npm `6.13.x`. To manage versions of node easily, we recommend [nvm](https://github.com/nvm-sh/nvm). | |
| 30 | +Use node (preferably exactly) `10.13.0` and npm `6.x`. To manage node versions easily, we recommend [nvm](https://github.com/nvm-sh/nvm) and use its deep integration feature to install and load the required node version automatically. | |
| 31 | 31 | |
| 32 | 32 | ### React Native |
| 33 | 33 | |
| 34 | 34 | Install the React Native CLI: |
| @@ -36,9 +36,9 @@ | ||
| 36 | 36 | ``` |
| 37 | 37 | npm install --global react-native-cli |
| 38 | 38 | ``` |
| 39 | 39 | |
| 40 | -and follow the [official React Native docs](https://facebook.github.io/react-native/docs/getting-started.html), choose "React Native CLI Quickstart", and then choose the **Development OS** and **Target OS** to match your use case. | |
| 40 | +and follow the [official React Native docs](https://reactnative.dev/docs/environment-setup), choose "React Native CLI Quickstart", and then choose the **Development OS** and **Target OS** to match your use case. | |
| 41 | 41 | |
| 42 | 42 | ### Android SDK |
| 43 | 43 | |
| 44 | 44 | If your target OS is Android, you need Android Studio and a recent Android SDK (installable through Android Studio). |
| @@ -47,9 +47,9 @@ | ||
| 47 | 47 | |
| 48 | 48 | You can also set the environment variable `ANDROID_NDK_HOME`, as in this example: |
| 49 | 49 | |
| 50 | 50 | ``` |
| 51 | -export ANDROID_NDK_HOME=/Users/username/Library/Android/sdk/ndk-bundle | |
| 51 | +export ANDROID_NDK_HOME=/Users/<username>/Library/Android/sdk/ndk-bundle | |
| 52 | 52 | ``` |
| 53 | 53 | |
| 54 | 54 | Also check out [nodejs-mobile docs](https://code.janeasystems.com/nodejs-mobile/getting-started-android#android-sdk-requirements) for the additional Android SDK requirements on your computer. |
| 55 | 55 | |
Built with git-ssb-web