summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorst33v <github@f3rr3t.com>2016-09-25 16:18:16 +1000
committerst33v <github@f3rr3t.com>2016-09-25 16:18:16 +1000
commitd86da38d5416edccdc44400c6fe137edf67abea1 (patch)
treec3d1beaf01b22794abe17ec5c352f375d9a4e4af
parentd59edc1825701466c60d0b9b63fe65f11c448c26 (diff)
Created a readme file
-rw-r--r--readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..01cb876
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,22 @@
+<!--- readme.md
+created 25 September 2016 (because of an effective little nag banner in github).
+-->
+
+# Takepix shell script and Systemd Timer
+
+## Intro
+Takepix is a systemd-driven script that takes photos periodically, under the control of a systemd timer.
+
+The script runs on a *raspberry pi* with an attached camera module.
+
+The Operating System that I use for raspberry pi is [Linux Arch ARM edition](https://archlinuxarm.org).
+
+To take the photos from the camera-equipped raspi, I use another raspi on the same LAN, which is running another service-based script, [getpix](/f3rr3t/getpix).:
+
+## Files
+
+File name | Purpose / functions
+----------|--------------------
+takepix.timer|A simple timer that calls takepix.service periodically
+takepix.service| Systemd service definition that is called by the Timer
+rakepix.sh|A shell script that takes trhe photo and performs quality checks