diff --git a/README.md b/README.md index f559689..47ac82f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # olaDMXctl -[![GitHub release](https://img.shields.io/badge/release-v1.0.2-orange)](https://github.com/DrMaxNix/oladmxctl/releases/tag/v1.0.2) -[![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/DrMaxNix/oladmxctl/blob/main/LICENSE) +[![Release](https://img.shields.io/badge/release-v1.0.2-orange)](https://git.tjdev.de/DrMaxNix/oladmxctl/releases/tag/v1.0.2) +[![License](https://img.shields.io/badge/license-MIT-green)](https://git.tjdev.de/DrMaxNix/oladmxctl/src/branch/main/LICENSE) [![Maintaner](https://img.shields.io/badge/maintainer-DrMaxNix-blue)](https://www.drmaxnix.de) Command-line tool for controlling individual dmx channels with olad @@ -13,29 +13,29 @@ Command-line tool for controlling individual dmx channels with olad ### php and curl This tool is coded in php and uses curl for http-requests so you need to have that installed -```bash -sudo apt update -sudo apt install php curl +```console +# apt update +# apt install php curl ``` ### download -Download the script from github -```bash -wget https://github.com/DrMaxNix/oladmxctl/releases/download/v1.0.2/oladmxctl +Download the script from git.tjdev.de +```console +$ wget -O oladmxctl https://git.tjdev.de/attachments/fc075f16-2923-4856-a4bf-621c5162bee4 ``` Make it executable -```bash -chmod +x oladmxctl +```console +$ chmod +x oladmxctl ``` ### move into /usr/bin (optional) You can skip this step. This will only make it so you can call the script from everywhere using `oladmxctl`. If you skip this step you will have to use `./oladmxctl` or `/path/to/oladmxctl` to run the script. -```bash -sudo mv oladmxctl /usr/bin +```console +# mv oladmxctl /usr/local/bin ``` @@ -70,14 +70,14 @@ oladmxctl --universe [--write ] [--read ] ## examples ### Set channel 13 and 14 to 255 in universe 1 -```bash -oladmxctl --universe 1 --write '{"13":255, "14":255}' +```console +$ oladmxctl --universe 1 --write '{"13":255, "14":255}' ``` ### Read channels 13 and 14 in universe 1 -```bash -oladmxctl --universe 1 --read '[13, 14]' +```console +$ oladmxctl --universe 1 --read '[13, 14]' ``` Returns `{"13":255, "14":255}`