diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1e3eed16..10613672 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# πŸ‘©β€πŸ’» Contributing +# Contributing We are open to any developer that wants to lend their hand at _Jellify_ development, and developers can join our [Discord server](https://discord.gg/jellify) to get in contact with us. @@ -12,13 +12,13 @@ Here's the best way to get started: - Submit a Pull Request to sync the main repository with your fork - Profit! πŸŽ‰ -## πŸƒβ€β™€οΈRunning Locally +## Running Locally -### βš›οΈ Universal Dependencies +### Universal Dependencies - [Ruby](https://www.ruby-lang.org/en/documentation/installation/) for Fastlane - [NodeJS v22](https://nodejs.org/en/download) for React Native -- [Maestro](https://docs.maestro.dev/getting-started/installing-maestro) for running E2E tests +- [Yarn](https://yarnpkg.com/) for managing dependencies ### 🍎 iOS @@ -71,9 +71,10 @@ Here's the best way to get started: ##### Building - To create a build, run `yarn fastlane:android:build` to use fastlane to compile an `.apk` for all architectures +- Alternatively, run `cd android; ./gradlew assembleRelease` to use Gradle to compile an `.apk` #### References - [Setting up Android SDK](https://developer.android.com/about/versions/14/setup-sdk) - [ANDROID_HOME not being set](https://stackoverflow.com/questions/26356359/error-android-home-is-not-set-and-android-command-not-in-your-path-you-must/54888107#54888107) -- [Android Auto app not showing up](https://www.reddit.com/r/AndroidAuto/s/LGYHoSPdXm) \ No newline at end of file +- [Android Auto app not showing up](https://www.reddit.com/r/AndroidAuto/s/LGYHoSPdXm)