Merge pull request #20 from jpage4500/feature/10-18

- WIP on jdeploy

.github/workflows/jdeploy.yml

@@ -42,7 +42,7 @@ jobs:
       - name: Install and run jdeploy
         run: |
           npm install jdeploy
-          npm publish
+          npx jdeploy publish
 
 #      - name: Build App Installer Bundles
 #        uses: shannah/jdeploy@master

README.md

@@ -24,41 +24,112 @@ Java desktop app to manage multiple Android devices via adb
 
 ## Screenshots ##
 <img src="resources/screenshot-main.jpg" width="600" alt="devices">
-<br>
+
+<details>
+  <summary>More Screenshots</summary>
 <img src="resources/screenshot-mirror.jpg" width="600" alt="devices">
 <br>
 <img src="resources/screenshot-browse.jpg" width="300" alt="file explorer">
 <br>
 <img src="resources/screenshot-logs.jpg" width="600" alt="logs">
 <br>
+</details>
+
+## Prerequisites
+
+- **adb** - android debugging tools
+- **scrcpy** - used to mirror a device ([link](https://github.com/Genymobile/scrcpy))
+
+<details>
+  <summary>Mac Setup</summary>
+
+### Install Homebrew
+
+```
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+```
+
+### Install adb
+
+```
+brew install --cask android-platform-tools
+```
+
+- add adb to PATH
+
+```
+echo 'export ANDROID_HOME=$HOME/Library/Android/sdk' >> ~/.profile
+echo 'export PATH="/opt/homebrew/bin:$ANDROID_HOME/platform-tools:$PATH"' >> ~/.profile
+```
+
+### Install scrcpy
+
+```
+brew install scrcpy
+```
+
+</details>
 
-## Requirements
+<details>
+  <summary>Windows Setup</summary>
 
+### Install adb
+download from [here](https://developer.android.com/tools/releases/platform-tools) and extract archive
+- move extracted platform-tools/ folder to your <HOME DIR>/Program Files/Android/
+- add the location to your PATH
+- test this by running “adb” in a command window
+
+### Install scrcpy
+
+download and install from [here](https://github.com/Genymobile/scrcpy/blob/master/doc/windows.md)
+- make sure “scrcpy” in in PATH
+</details>
+
+<details>
+  <summary>Linux Setup</summary>
+
+### Install adb
+```
+sudo apt-get install adb
+```
+### Install scrcpy
+see this [link](https://github.com/Genymobile/scrcpy/blob/master/doc/linux.md#latest-version)
+
+</details>
+
+## Install Android Device Manager
+
+I'm using jdeploy to package this as a native app for Mac/Windows/Linux. This also allows for automatic updates
+
+To install open a terminal and run this command:
+```
+/bin/bash -c "$(curl -fsSL https://www.jdeploy.com/~android-device-manager/install.sh)"
+```
+
+See [this page](https://www.jdeploy.com/~android-device-manager) to download the installer directly
+
+## Build
+
+<details>
+  <summary>Build Android Device Manager</summary>
+
+## Prerequisites
 - Java SDK
   - min version 17; I'm using openjdk 22.0.1 2024-04-16
   - MacOSX -> Homebrew -> `brew install openjdk`
   - Linux - [link](https://www.digitalocean.com/community/tutorials/how-to-install-java-with-apt-on-ubuntu-22-04)
-- **adb**
-  - MacOSX -> homebrew -> `brew cask install android-platform-tools`
-  - Linux -> `sudo apt install adb fastboot`
-  - standalone adb tools can be found [here](https://developer.android.com/tools/releases/platform-tools)
-- **scrcpy** - mirror a connected Android device ([https://github.com/Genymobile/scrcpy](https://github.com/Genymobile/scrcpy))
-  - MacOSX -> homebrew -> `brew install scrcpy`
-  - Linux -> see [link](https://github.com/Genymobile/scrcpy/blob/master/doc/linux.md#latest-version)
-- make sure both `adb` and `scrcpy` are in the current PATH
-
-## Run
-
-- Download the latest release from here: [https://github.com/jpage4500/AndroidDeviceManager/releases](https://github.com/jpage4500/AndroidDeviceManager/releases)
-  - Mac OSX Users:
-    - get the packaged .app version: `AndroidDeviceManager-VERSION-OSX.zip`, extract and move to `/Applications` folder
-  - Windows/Linux Users:
-    - get the .jar version: `AndroidDeviceManager.jar`
-    - run via command-line: `java -jar AndroidDeviceManager.jar`
+- Maven
+  - MacOSX -> Homebrew -> `brew install maven`
+  - Linux - [link](https://www.digitalocean.com/community/tutorials/install-maven-linux-ubuntu)
 
 ## Build
-
-[Build Instructions](BUILD.md)
+- sync this repo
+  - `git clone https://github.com/jpage4500/AndroidDeviceManager.git`
+- build
+  - `mvn compile`
+- run:
+  - `mvn exec:java`
+</details>
 
 ## Use Cases ##