Skip to content

Commit

Permalink
Included Release Information in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Fahim-zzz authored Dec 2, 2024
1 parent 9ef80af commit 9d16b58
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,31 @@
## Description

DAIRemote is a versatile display, audio, and input remote for Windows desktops. It allows users to:
* Save, load, update, and delete display profiles
* Save and load display profiles
* Cycle through audio playback devices
* Use hotkeys for audio cycling, audio playback devices, and display profiles
* Use an Android phone as a keyboard and mouse input
* Use an Android device as keyboard and mouse input, apply saved display profiles, and modify the host's audio device.

All of these features can be controlled remotely, providing convenience from wherever you're sitting.
All from the comfort of wherever you're sitting.

## Getting Started
Follow the [installation guide](INSTALLATION.md) for detailed setup and build instructions. Once installed:
1. Run the desktop application using `dotnet run`.
2. Use the Android app for remote input and device management.
Our latest release can be found at [releases](https://github.com/WSU-4110/DAIRemote/releases/tag/Release).
### Desktop
1. First, extract the contents of DAIRemote.zip to a desired location.
2. Simply double click the DAIRemote.exe to start the deskptop application.
### Android
1. Connect your android device to your desktop with a suitable cable & file transfer enabled.
2. Download and drop the DAIRemote.apk to your desired location on your android device.
3. Open the file from the stored location on your android and begin the installation. You may be prompted to provide permissions to do so.

For a step-by-step walkthrough, check out our video guide: [Getting Started with DAIRemote](https://www.youtube.com/watch?v=8atqA3T8YL0)
For a step-by-step walkthrough on using our desktop and android application, check out our video guide: [Getting Started with DAIRemote](https://www.youtube.com/watch?v=8atqA3T8YL0)

## Running the Android Application
1. **Using BlueStacks**:
* Install BlueStacks and launch the app from the built APK file.
2. **Using Command Line**:
* Ensure Android SDK and required tools are set up. [More details here](INSTALLATION.md).
If interested in building the project from the source, checkout our [installation guide](INSTALLATION.md).

## Authors

* Shawinder Minhas (shawiminhas) - hk1225@wayne.edu <br />
* Lynn Hakim (lynnhakim) - hk9794@wayne.edu <br />
* Fahim Zaman (Fahim-zzz) - FahimZaman@wayne.edu <br />
* Mehad Ali (mehad123) - fj2852@wayne.edu <br />
* Shawinder Minhas (shawiminhas) - hk1225@wayne.edu <br />
* Lynn Hakim (lynnhakim) - hk9794@wayne.edu <br />
* Domenic Zarza (dzarza2003) - hi5947@wayne.edu <br />

0 comments on commit 9d16b58

Please sign in to comment.