diff options
Diffstat (limited to 'docs/Usage')
| -rw-r--r-- | docs/Usage/CLI.md | 8 | ||||
| -rw-r--r-- | docs/Usage/Configuration.md | 20 | ||||
| -rw-r--r-- | docs/Usage/Install.md | 12 | ||||
| -rw-r--r-- | docs/Usage/README.md | 11 |
4 files changed, 21 insertions, 30 deletions
diff --git a/docs/Usage/CLI.md b/docs/Usage/CLI.md index 6052193..979521a 100644 --- a/docs/Usage/CLI.md +++ b/docs/Usage/CLI.md @@ -9,9 +9,8 @@ or is alias ```bash $ lux-neo ``` -{% hint style='danger' %} -This CLI assumes root access, so please run it with `sudo` -{% endhint %} +!!! danger "Important!" + This CLI assumes root access, so please run it with `sudo` ## Options ### `sudo lux-neo uninstall` @@ -93,4 +92,5 @@ Luxcena-neo-cli [args: 'version'] ### `sudo lux-neo selectBranch <branch>` This will change what branch you are on to <branch>. Stashing changes (shouldn't be a concern, but just saying it anyways). -*Please note that the version-checker now will just be useless, as it does not now what branch we really are on.* +!!! note + Please note that the version-checker now will just be useless, as it does not now what branch we really are on. diff --git a/docs/Usage/Configuration.md b/docs/Usage/Configuration.md index f13d639..c715a75 100644 --- a/docs/Usage/Configuration.md +++ b/docs/Usage/Configuration.md @@ -22,9 +22,9 @@ When running the command above, a config file should appear in the editor 'nano' "led_channel": 0 } ``` -{% hint style='tip' %} -If you rather want to use vim or another editor, the file is at `/home/lux-neo/userdata/config/strip.json` -{% endhint %} + +??? tip "Tip - Change editor" + If you rather want to use vim or another editor, the file is at `/home/lux-neo/userdata/config/strip.json` ## led_count @@ -49,15 +49,15 @@ This is a two dimensonal array, used to arrange the segments in a matrix of your ] ``` Each entry looks is a list, with two parameters, `[<segment_number>, <invert>]` -{% hint style='danger' %} -If you don't have a reference to all the segments or something, the matrix setup will fail. And fall back to 'segmentsconfiguration' -{% endhint %} +!!! danger "Warning" + If you don't have a reference to all the segments or something, the matrix setup will fail. And fall back to 'segmentsconfiguration' + ## segmentconfiguration If the matrix-option is empty or badly setup. The matrix will be set up using one of these defaults: -``` +```json "snake": "line": "random": @@ -67,9 +67,9 @@ If the matrix-option is empty or badly setup. The matrix will be set up using on If using the luxcena-shield, you shouldn't have to worry about this option. But set it to the GPIO-port connected to your pixel's din-port. ## led_dma -{% hint style='danger' %} -If using a newer RPi (3 or newer), leave this as 10! Or your file-system might crash. -{% endhint %} +!!! danger "Warning" + If using a newer RPi (3 or newer), leave this as 10! Or your file-system might crash. + This is the dma-channel used to generate the data-stream. If you for some reason need channel 10 for something else, you can change it. But i strongly recommend leaving it to 10! ## led_invert diff --git a/docs/Usage/Install.md b/docs/Usage/Install.md index 5f19d39..b9a48ee 100644 --- a/docs/Usage/Install.md +++ b/docs/Usage/Install.md @@ -13,21 +13,23 @@ If you want to install luxcena-neo to use it, these are the instructions: 1. Start with logging into your Raspberry Pi 2. Run these commands ```bash -$ git clone https://github.com/JakobST1n/Luxcena-Neo -$ cd Luxcena-Neo -$ sudo ./bin/install.sh +git clone https://github.com/JakobST1n/Luxcena-Neo +cd Luxcena-Neo +sudo ./bin/install.sh ``` 3. Follow the instructions on screen. You should answer yes to most of the questions. 4. The install-process might seem to hang, but there is just no output being sent to the console. If you want to see a bit more verbose output. Open another terminal session, and run this command: ```bash -$ tail -n 10 -f /tmp/luxcena-neo.install.log +tail -n 10 -f /tmp/luxcena-neo.install.log ``` This is also where you will find possible reasons for a failed install. 4. Luxcena-Neo should now be installed. Start it with this command ```bash -$ luxcena-neo start +luxcena-neo start ``` +!!! Default User "neo":"luxcena-neo" + ## Troubleshooting We haven't encountered any troubles yet, but once we do, we will post fix'es here. diff --git a/docs/Usage/README.md b/docs/Usage/README.md deleted file mode 100644 index ce62034..0000000 --- a/docs/Usage/README.md +++ /dev/null @@ -1,11 +0,0 @@ -# Usage - - -## [Install](/Usage/Install.md) -Want to install luxcena-neo? This is the guide! - -## [Configuration](/Usage/Configuration.md) -Just installed luxcena-neo, or you have changed your setup? This is the guide! - -## [CLI](/Usage/CLI.md) -Ready to start the thing? Or change something? |