aboutsummaryrefslogtreecommitdiff
path: root/docs/Usage/Install.md
diff options
context:
space:
mode:
authorJakob Stendahl <jakob.stendahl@outlook.com>2018-11-29 23:14:58 +0100
committerJakob Stendahl <jakob.stendahl@outlook.com>2018-11-29 23:14:58 +0100
commit101745c6a4a2c6a186be48182d48814177840c65 (patch)
treeee7c7420291473033cf7cd9f921fe21958bf571f /docs/Usage/Install.md
parent2147880e40ee39ae07c8df9d3500080da467475d (diff)
downloadLuxcena-Neo-101745c6a4a2c6a186be48182d48814177840c65.tar.gz
Luxcena-Neo-101745c6a4a2c6a186be48182d48814177840c65.zip
:construction: Chenged things, and written some docs
Diffstat (limited to 'docs/Usage/Install.md')
-rw-r--r--docs/Usage/Install.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/Usage/Install.md b/docs/Usage/Install.md
new file mode 100644
index 0000000..ced241a
--- /dev/null
+++ b/docs/Usage/Install.md
@@ -0,0 +1,32 @@
+# Installation
+
+If you want to install luxcena-neo to use it, these are the instructions:
+
+---
+
+## Requirements
+* The luxcena-shield
+* Access to the raspberry pi (SSH or direct)
+* Root access (preferably through the `sudo` command)
+
+## Install
+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
+```
+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
+```
+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
+```
+
+## Troubleshooting
+We haven't encountered any troubles yet, but once we do, we will post fix'es here.