aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorjakob.stendahl <jakob.stendahl@infomedia.dk>2022-12-18 00:05:50 +0100
committerJakob Stendahl <jakob.stendahl@outlook.com>2022-12-18 00:05:50 +0100
commit2c8063a1697ce4c737a2296b8d6385c9cf761f07 (patch)
treeb46312848930f3f2e590f94c61587902eade3d54 /README.md
parent1e588718a855ae2871a8841f6c6e621f49795454 (diff)
downloadLuxcena-Neo-2c8063a1697ce4c737a2296b8d6385c9cf761f07.tar.gz
Luxcena-Neo-2c8063a1697ce4c737a2296b8d6385c9cf761f07.zip
Make the updater work properly
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index ae63385..b419684 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,17 @@ Raspberry-pi addressable LED controller software
## Wiki
The wiki will be available right in the browser when you have the software installed. If you want to contribute, you follow standard procedures for contributing here, and change/add/delete the markdown-files found in `/docs`. Don't worry about the `_book` folder, as that contains the generated html wiki.
+
## Install
+The simplest way to install it is using the install script:
```
wget https://raw.githubusercontent.com/JakobST1n/Luxcena-Neo/master/bin/install.sh && chmod +x install.sh && sudo ./install.sh && rm install.sh
```
+
+You can also install the latest package from the releases. Just download the `luxcena-neo-<version>.tgz` file you want, and run `npm i <package.tgz>`. By using this method the auto update and stuff like that will not work by itself. You can check the install-script to see what you need. But mostly you just need something to run `node app.js`.
+It is not that clever, it basically
+
+. Creates the user `lux-neo` and adds it to the `gpio` and `spi` groups.
+. Creates folders `/var/luxcena-neo` `/etc/luxcena-neo` and `/var/log/luxcena-neo`.
+. Installs nodejs, pip and some other dependencies (which probably is installed already).
+. Downloads the luxcena-neo package, and installs it to the home-directory of the new `lux-neo` user.