Commit e733c7f9 authored by Hermann Mayer's avatar Hermann Mayer
Browse files

[Docs] Added an about the setup section on the readme. (See #9)

parent fb4f02e0

README.md

+18 −4
Original line number Diff line number Diff line
@@ -11,7 +11,7 @@ off or just toggle it. 
- [Requirements](#requirements)

- [Installation](#installation)

  - [From Source](#from-source)

  - [ArchLinux Packaging](#archlinux-packaging)

  - [Arch Linux Packaging](#arch-linux-packaging)

- [Configuration](#configuration)

  - [Service](#service)

  - [Process management](#process-management)
@@ -19,9 +19,17 @@ off or just toggle it. 


## About the setup



The project runs productive on a [Raspberry Pi Model B rev2][] with [Arch Linux

ARM][] as distribution. For detecting human motions the [PIR Motion Sensor from

Seeed Studio][] was used.  The [Light Sensor Brick from ITead Studio][] was

used to detect the ambient light level. This sensor was attached to an

[MCP3008, 10 Bit / 8 Channel ADC][] which is connected via the SPI bus to the

Raspberry Pi. For further details consider the [Platform and Wiring][] wiki

page.



## Requirements



The project need the following libraries to build:

The project needs the following libraries to build:



* [glibc](https://www.gnu.org/software/libc/) (>=2.20)

* [openssl](https://www.openssl.org/) (>=1.0.1.l)
@@ -30,8 +38,8 @@ The project need the following libraries to build: 
* [libconfig](http://www.hyperrealm.com/libconfig/) (>=1.5)

* [libbcm2835](http://www.airspayce.com/mikem/bcm2835/) (>=1.46)



The versions describe the lowest tested version. Is it possible that lower

and/or higher versions will run fine, too.

The versions behind the libraries are describing the lowest tested versions. Is it

possible that lower and/or higher versions will run fine, too.



The project was successfully compiled with the [GCC](https://gcc.gnu.org/) (>=4.9.2).
@@ -116,6 +124,12 @@ you plan to work on the project. 


[avm-motion-triggerd]: ../../wikis/man/avm-motion-triggerd.1.html

[avm-motion-trigger.conf]: ../../wikis/man/avm-motion-trigger.conf.5.html

[Platform and Wiring]: ../../wikis/platform-and-wiring

[Contribution Guide]: CONTRIBUTING.md

[.editorconfig file]: .editorconfig

[standard directory variables]: https://www.gnu.org/prep/standards/html_node/Directory-Variables.html

[Raspberry Pi Model B rev2]: https://www.raspberrypi.org

[Arch Linux ARM]: http://archlinuxarm.org/

[Light Sensor Brick from ITead Studio]: http://wiki.iteadstudio.com/Light_Sensor_Brick

[PIR Motion Sensor from Seeed Studio]: http://www.seeedstudio.com/wiki/PIR_Motion_sensor_module

[MCP3008, 10 Bit / 8 Channel ADC]: http://www.adafruit.com/products/856