diff --git a/readme.md b/readme.md index cf4a4930..8bd0a470 100644 --- a/readme.md +++ b/readme.md @@ -11,3 +11,88 @@ Get the Android app on the [Google Play Store](https://play.google.com/store/app **Currently in Beta** - **Requires an Audiobookshelf server to connect with** Screenshot1 + + +## Contributing + +### Windows Environment Setup + +Required Software + +* [Git](https://git-scm.com/downloads) +* [Node.js](https://nodejs.org/en/) +* Code editor of choice([VSCode](https://code.visualstudio.com/download), etc) +* [Android Studio](https://developer.android.com/studio) + +
+Install the applications with winget + +

+Note: This requires a PowerShell prompt with winget installed. You should be able to copy and paste the code block to install. If you use an elevated PowerShell prompt, UAC will not pop up during the installs. + +```PowerShell +winget install -e --id Git.Git; ` +winget install -e --id Microsoft.VisualStudioCode; ` +winget install -e --id Google.AndroidStudio; ` +winget install -e --id OpenJS.NodeJS --version 16.12.0; #v17 has issues with openssl +``` + +![](/screenshots/dev_setup_windows_winget.png) + +

+
+
+ +Your Windows environment should now be set up and ready to proceed! + +### Mac Environment Setup + + +### 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: +``` +npm install +``` +
+Expand for screenshot + +![](/screenshots/dev_setup_npm_install.png) +
+
+Generate static web app: +``` +npm run generate +``` +
+Expand for screenshot + +![](/screenshots/dev_setup_npm_run.png) +
+
+ +Copy web app into native android/ios folders: +``` +npx cap sync +``` +
+Expand for screenshot + +![](/screenshots/dev_setup_cap_sync.png) +
+
+ +Open Android Studio: +``` +npx cap open android +``` +
+Expand for screenshot + +![](/screenshots/dev_setup_cap_android.png) +
+ +Start coding! \ No newline at end of file diff --git a/screenshots/dev_setup_cap_android.png b/screenshots/dev_setup_cap_android.png new file mode 100755 index 00000000..c34cce25 Binary files /dev/null and b/screenshots/dev_setup_cap_android.png differ diff --git a/screenshots/dev_setup_cap_sync.png b/screenshots/dev_setup_cap_sync.png new file mode 100755 index 00000000..6c66b4b3 Binary files /dev/null and b/screenshots/dev_setup_cap_sync.png differ diff --git a/screenshots/dev_setup_npm_install.png b/screenshots/dev_setup_npm_install.png new file mode 100755 index 00000000..43a07e2f Binary files /dev/null and b/screenshots/dev_setup_npm_install.png differ diff --git a/screenshots/dev_setup_npm_run.png b/screenshots/dev_setup_npm_run.png new file mode 100755 index 00000000..4fb81866 Binary files /dev/null and b/screenshots/dev_setup_npm_run.png differ diff --git a/screenshots/dev_setup_windows_winget.png b/screenshots/dev_setup_windows_winget.png new file mode 100755 index 00000000..af8b0aea Binary files /dev/null and b/screenshots/dev_setup_windows_winget.png differ