aboutsummaryrefslogtreecommitdiff
path: root/docs/Usage/Install.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 /docs/Usage/Install.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 'docs/Usage/Install.md')
-rw-r--r--docs/Usage/Install.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/Usage/Install.md b/docs/Usage/Install.md
new file mode 100644
index 0000000..5f19d39
--- /dev/null
+++ b/docs/Usage/Install.md
@@ -0,0 +1,35 @@
+# 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.
+
+---
+You should now be all set to [configuring luxcena-neo](/Usage/Configuration.md).