diff --git a/README.md b/README.md index 8ec4be7..e74a4e4 100644 --- a/README.md +++ b/README.md @@ -28,47 +28,50 @@ When the connection is established, the client will stream data to the server vi *Whatever dude how do I install it?* ## Installation instructions -- **Client** (e.g. Windows PC): - 1. Download the *client* binary for your operating system from [here](https://github.com/SHT/Core/releases/latest/). - 2. Create a `run.bat` file on the same folder as the binary. - 3. Paste the following on the `run.bat` file, replacing `IP`, `PORT`, `LEDS_COUNT` and `FRAMERATE` accordingly. - ``` - client.exe IP PORT LEDS_COUNT FRAMERATE - ``` +#### Client (e.g. Windows PC) - 4. Double click the `run.bat` file to launch the client. It will autoconnect to the server once the server is online. +1. Download the *client* binary for your operating system from [here](https://github.com/SHT/Core/releases/latest/). +2. Create a `run.bat` file on the same folder as the binary. +3. Paste the following on the `run.bat` file, replacing `IP`, `PORT`, `LEDS_COUNT` and `FRAMERATE` accordingly. + ``` + client.exe IP PORT LEDS_COUNT FRAMERATE + ``` -- **Server** (e.g. Raspberry Pi Zero W): - 1. Download the *server* binary for your operating system from [here](https://github.com/SHT/Core/releases/latest/). - 2. Install `tmux` using the following command: +4. Double click the `run.bat` file to launch the client. It will autoconnect to the server once the server is online. - `sudo apt-get install tmux` - 3. Create a `run.sh` file on the same folder as the binary. Make sure the file is marked as executable: +#### Server (e.g. Raspberry Pi Zero W) - `chmod +x server` +1. Download the *server* binary for your operating system from [here](https://github.com/SHT/Core/releases/latest/). +2. Install `tmux` using the following command: - 4. Paste the following on the `run.sh` file, replacing `AMBILIGHT_FOLDER`, `LEDS_COUNT`, `BRIGHTNESS`, `PIN` and `PORT` accordingly. - The arguments `PIN` and `PORT` are optional and default to `18` and `4197` respectively. + `sudo apt-get install tmux` - ``` - #!/bin/bash - tmux new-session -d -s ambilight 'cd /AMBILIGHT_FOLDER && ./server LEDS_COUNT BRIGHTNESS PIN PORT' - ``` +3. Create a `run.sh` file on the same folder as the binary. Make sure the file is marked as executable: - 5. (optional) Start the server at boot: Edit the `/etc/rc.local` file, adding the following before the `exit 0` line, replacing `AMBILIGHT_FOLDER` with the folder where the ambilight server binary resides. + `chmod +x server` - ``` - /AMBILIGHT_FOLDER/run.sh - ``` +4. Paste the following on the `run.sh` file, replacing `AMBILIGHT_FOLDER`, `LEDS_COUNT`, `BRIGHTNESS`, `PIN` and `PORT` accordingly. + The arguments `PIN` and `PORT` are optional and default to `18` and `4197` respectively. - 6. Execute the run.sh file to start the Ambilight server (or reboot if you configured start at boot): + ``` + #!/bin/bash + tmux new-session -d -s ambilight 'cd /AMBILIGHT_FOLDER && ./server LEDS_COUNT BRIGHTNESS PIN PORT' + ``` - ``` - ./run.sh - ``` +5. (optional) Start the server at boot: Edit the `/etc/rc.local` file, adding the following before the `exit 0` line, replacing `AMBILIGHT_FOLDER` with the folder where the ambilight server binary resides. + + ``` + /AMBILIGHT_FOLDER/run.sh + ``` + +6. Execute the run.sh file to start the Ambilight server (or reboot if you configured start at boot): + + ``` + ./run.sh + ``` ## Modes