aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorjakobst1n <jakob.stendahl@outlook.com>2018-09-07 00:32:51 +0200
committerjakobst1n <jakob.stendahl@outlook.com>2018-09-07 00:32:51 +0200
commit78d7c8d75a5f55ab56dd018edc85ebce9aa033bb (patch)
tree2ad9da977667b79236cfdd827d0446a5bf9fea18 /README.md
downloadLuxcena-Neo-78d7c8d75a5f55ab56dd018edc85ebce9aa033bb.tar.gz
Luxcena-Neo-78d7c8d75a5f55ab56dd018edc85ebce9aa033bb.zip
:construction: Add pre-v1 project
Because of some stupid mistakes with the repo, I decided to delete the git history. Create a new, fresh repo, and move all the code there. Since all this is pre-v1, everything is in a testing-phase anyways. So i do not think we are going to feel the need for any history. The old repo is renamed to Luxcena-Neo-Old, and will be there until i convince myself i won't need the history.
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!*