aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..10fd89e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# Luxcena-Neo
+Dependencies [![dependencies Status](https://david-dm.org/jakobst1n/luxcena-neo/dev/status.svg)](https://david-dm.org/jakobst1n/luxcena-neo)[![devDependencies Status](https://david-dm.org/jakobst1n/luxcena-neo/dev/dev-status.svg)](https://david-dm.org/jakobst1n/luxcena-neo?type=dev)
+
+Branch (dev) [![dependencies Status](https://david-dm.org/jakobst1n/luxcena-neo/dev/status.svg)](https://david-dm.org/jakobst1n/luxcena-neo/dev)[![devDependencies Status](https://david-dm.org/jakobst1n/luxcena-neo/dev/dev-status.svg)](https://david-dm.org/jakobst1n/luxcena-neo/dev?type=dev)
+
+
+## Wiki
+https://luxcena.gitbook.io/luxcena-neo
+## 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
+```
+## 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!*