Skip to content

Commit a3078f2

Browse files
Merge pull request #27 from SensorsIot/readme-update
Update README.md
2 parents 67e0056 + 15d840b commit a3078f2

File tree

1 file changed

+34
-2
lines changed

1 file changed

+34
-2
lines changed

README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,35 @@
1-
Documentation for the project: https://sensorsiot.github.io/IOTstack/
1+
# IOT Stack
2+
IOTstack is a builder for docker-compose to easily make and maintain IoT stacks on the Raspberry Pi.
23

3-
Video: https://youtu.be/a6mjt8tWUws
4+
## Documentation for the project:
5+
6+
https://sensorsiot.github.io/IOTstack/
7+
8+
## Video
9+
https://youtu.be/a6mjt8tWUws
10+
11+
## Installation
12+
1. On the (PRi) lite image you will need to install git first
13+
14+
```
15+
sudo apt-get install git -y
16+
```
17+
18+
2. Download the repository with:
19+
```
20+
git clone https://github.com/SensorsIot/IOTstack.git ~/IOTstack
21+
```
22+
23+
Due to some script restraints, this project needs to be stored in ~/IOTstack
24+
25+
3. To enter the directory and run menu for installation options:
26+
```
27+
cd ~/IOTstack && bash ./menu.sh
28+
```
29+
30+
4. Install docker with the menu, restart your system.
31+
32+
5. Run menu again to select your build options, then start docker-compose with
33+
```
34+
docker-compose up -d
35+
```

0 commit comments

Comments
 (0)