aboutsummaryrefslogtreecommitdiff
path: root/docs/Usage/Install.md
diff options
context:
space:
mode:
authorJakob Stendahl <14180120+JakobST1n@users.noreply.github.com>2018-12-01 00:28:28 +0100
committerGitHub <noreply@github.com>2018-12-01 00:28:28 +0100
commit19df9946b438b38b9a4f3f57ad002981a1ae1eaf (patch)
treee8eb839a305502584e31e1b1a96c70406b9b6255 /docs/Usage/Install.md
parentfd7a1b51126f8b8f889807cb7d56bb3626a0e0b5 (diff)
parent7ec685de6e441af1f614bb9d18e25c047d21466b (diff)
downloadLuxcena-Neo-19df9946b438b38b9a4f3f57ad002981a1ae1eaf.tar.gz
Luxcena-Neo-19df9946b438b38b9a4f3f57ad002981a1ae1eaf.zip
Merge pull request #6 from JakobST1n/dev
Written docs, finished CLI
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).