diff --git a/readme.md b/readme.md index 8bd0a470..8412e2be 100644 --- a/readme.md +++ b/readme.md @@ -17,7 +17,7 @@ Get the Android app on the [Google Play Store](https://play.google.com/store/app ### Windows Environment Setup -Required Software +Required Software: * [Git](https://git-scm.com/downloads) * [Node.js](https://nodejs.org/en/) @@ -47,26 +47,44 @@ Your Windows environment should now be set up and ready to proceed! ### Mac Environment Setup +Required Software: + +* [Android Studio](https://developer.android.com/studio) +* [Node.js](https://nodejs.org/en/) + +
+Install the applications with homebrew + +

+ +```zsh +brew install android-studio node +``` + +

+
### Start working on the project - Clone or fork the project from cmd or powershell and `cd` into the project directory. -Install the required node packages: -``` +Install the required node packages: +```shell npm install ``` +
Expand for screenshot ![](/screenshots/dev_setup_npm_install.png)

-Generate static web app: -``` + +Generate static web app: +```shell npm run generate ``` +
Expand for screenshot @@ -75,9 +93,10 @@ npm run generate
Copy web app into native android/ios folders: -``` +```shell npx cap sync ``` +
Expand for screenshot @@ -86,13 +105,16 @@ npx cap sync
Open Android Studio: -``` + +```shell npx cap open android ``` +
Expand for screenshot ![](/screenshots/dev_setup_cap_android.png)
+
-Start coding! \ No newline at end of file +Start coding!