Update to match install.sh

timelapse/README.md

@@ -0,0 +1,30 @@
+# Linux Webcam Time Lapse Script
+This is a simple set of scripts to easily capture images on a set interval using a webcam attached to a Linux machine. For my use case I have built and tested this on a Raspberry Pi 3 with a Logitech C90 1080p webcam.
+
+## How it works
+* This script depends on `fswebcam` and `rsync` to work. An image is captured with `fswebcam` and stored locally, then synced to a remote device (ie. NAS).
+* Everything should be easily configurable from variables at the top of each file.
+* The install script just copies the script files to an install directory of your choice and does `chmod +x` on them.
+* Right now the script needs `root`/`sudo` permission as it syncs the files to a device that requires root for me. An adaptation of the script would negate the need for `root` permissions.
+* `tl-control` creates a cron file in `/etc/cron.d` named `timelapse` with a job that runs `tl-capture` as root and redirects the output to `/var/log/timelapse.log`
+
+## Explanation of Variables
+#### `install.sh`
+```
+INSTALL_DIR -- Directory to install the script files to
+FILE_LIST -- List of file names to be installed, shouldn't change unless you're modifying the script or names
+```
+
+#### `tl-control`
+```
+INSTALL_DIR -- Directory that the script files were installed to, must match install.sh
+FILE_LIST -- List of file names installed as part of the script, must match install.sh
+IMG_DIR -- Directory to save timelapse images to before syncing
+SYNC_DES_PATH -- Complete path to sync destination directory
+# Cron
+CRON_DIR -- Complete path to your system's cron.d directory
+CRON_FILE -- What to name the cron job file.
+CRON_FREQUENCY -- Will get set by the script when starting a time lapse
+CRON_LOG_PATH -- Complete path to output log location, including filename
+CRON_JOB -- Text of the cron job, starting with the user, do not include frequency here
+```