diff options
| author | Jakob Stendahl <14180120+JakobST1n@users.noreply.github.com> | 2018-12-01 00:44:09 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-12-01 00:44:09 +0100 |
| commit | aad05799241efb6af80290696081fb80ac42c0ea (patch) | |
| tree | 5c20e3e38be7c86b3cf71afedd9a7815d250cb34 /README.md | |
| parent | 19df9946b438b38b9a4f3f57ad002981a1ae1eaf (diff) | |
| download | Luxcena-Neo-aad05799241efb6af80290696081fb80ac42c0ea.tar.gz Luxcena-Neo-aad05799241efb6af80290696081fb80ac42c0ea.zip | |
:memo: Explain the new docs
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 9 insertions, 9 deletions
@@ -1,17 +1,17 @@ -# Luxcena-Neo +# +Luxcena-Neo Dependencies [](https://david-dm.org/jakobst1n/luxcena-neo)[](https://david-dm.org/jakobst1n/luxcena-neo?type=dev) Branch (dev) [](https://david-dm.org/jakobst1n/luxcena-neo/dev)[](https://david-dm.org/jakobst1n/luxcena-neo/dev?type=dev) ## Wiki -https://luxcena.gitbook.io/luxcena-neo +The wiki will be available right in the browser when you have the software installed. If you want to contribute, you follow standard procedures for contributing here, and change/add/delete the markdown-files found in `/docs`. Don't worry about the `_book` folder, as that contains the generated html wiki. ## Install -To install on a Raspberry pi, make sure you are using the "pi" user. -``` -git clone https://github.com/JakobST1n/Luxcena-Neo -cd luxcena-neo -sudo ./bin/install.sh -``` +To install, follow the guide here: [Install Luxcena-Neo](https://github.com/JakobST1n/Luxcena-Neo/blob/master/docs/Usage/Install.md) + +The link there won't work on github, only when starting the software. So here is the link to the configuration-guide: +[Configuring Luxcena-Neo](https://github.com/JakobST1n/Luxcena-Neo/blob/master/docs/Usage/Configuration.md) + ## Issues -*PLEASE NOTE THAT IT DOES NOT WORK WHITOUT A LOT OF TWEAKING. FEEL FREE TO GIVE IT A SHOT, BUT I AM WORKING HARD ON MAKING IT EASY TO USE!* +*There might still be a bit hard for someone not having spent hours looking at the source to use this software. But i assure you that it will be really easy to use shortly* |