aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJakob Stendahl <jakob.stendahl@outlook.com>2019-09-22 13:12:44 +0200
committerJakob Stendahl <jakob.stendahl@outlook.com>2019-09-22 13:12:44 +0200
commite6880cd8ccf82d993f222cb14b4860581654acb8 (patch)
tree45f318f4ece2f0d6ca73fc3f775b9ba277ccdb77 /README.md
parente911f8029ca612d3b17ced300cdf5b6f13e20972 (diff)
parent2e60b25ae368b8c19ce5e982aa2672a6c56edf90 (diff)
downloadLuxcena-Neo-e6880cd8ccf82d993f222cb14b4860581654acb8.tar.gz
Luxcena-Neo-e6880cd8ccf82d993f222cb14b4860581654acb8.zip
Merge branch 'master' of https://github.com/JakobST1n/Luxcena-Neo
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 7 insertions, 8 deletions
diff --git a/README.md b/README.md
index 10fd89e..254b100 100644
--- a/README.md
+++ b/README.md
@@ -5,13 +5,12 @@ Branch (dev) [![dependencies Status](https://david-dm.org/jakobst1n/luxcena-neo
## 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
-./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 WE ARE WORKING HARD ON MAKING IT WASY 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*