From 9c195b8254dbab89e3b4d4a5360f294c9c3f5047 Mon Sep 17 00:00:00 2001 From: Bo Date: Thu, 13 Dec 2018 14:06:00 +0100 Subject: [PATCH] changed README.md --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 45d4ef8..873a8de 100755 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -###### WELCOME TO THE README PAGE of # IRIS # ###### +# WELCOME TO THE README PAGE of # IRIS -Iris 0.5 is a smart machine that interacts with you via audio, camera and visual effects. It aims to be installed in a workplace environment. Iris has 3 characters: guru, pirate and announcer. The files follow this nomination. +Iris is a smart machine that interacts with you via audio, camera and visual effects. It aims to be installed in a workplace environment. Iris has 3 characters: guru, pirate and announcer. The files follow this nomination. -### THE FILES ### +## THE FILES * The .json files (“guru.json”, “rebel.json” and “announcer.json”) are the files where all the sentences the characters say are stored. * The script “guru-pirate.py” is the script that combines content of guru and pirate (from json files) to play their messages. It also integrates LEDs when the characters speak. When characters speak the LEDs light up and perform effects. This script runs when the camera detects motion. @@ -14,7 +14,7 @@ Iris 0.5 is a smart machine that interacts with you via audio, camera and visual -### INSTALL INDEPENDENCIES ### +## INSTALL DEPENDENCIES * 2018-12-12 * Performed in linux Debian @@ -53,7 +53,7 @@ Iris 0.5 is a smart machine that interacts with you via audio, camera and visual — Install sox (to play the colophon) sudo apt-get install sox -### RUN THE PROGRAM ON RASPBERRY PI AT STARTUP ### +## RUN THE PROGRAM ON RASPBERRY PI AT STARTUP Tutorial on how to run a program on your Raspberry Pi at startup: https://www.dexterindustries.com/howto/run-a-program-on-your-raspberry-pi-at-startup/ @@ -90,23 +90,23 @@ Now the unit file has been defined we can tell systemd to start it during the bo Reboot the Pi and your custom service should run: sudo reboot -### LOCATION +## LOCATION * scripts locations /var/www/html/lifeHackAgent * audio recording script /var/www/html/lifeHackAgent/Audio_recordings -### ORIGINAL FILE +## ORIGINAL FILE * guru-pirate: /var/www/html/lifeHackAgent/guru-pirate.py * /var/www/html/lifeHackAgent/announcer.py * colophon: /var/www/html/lifeHackAgent/colophon/ -### TEST SYSTEM: +## TEST SYSTEM: * `./motion.sh` -### CRONJOB: +## CRONJOB: runs announcements.py -### systemd service file +## systemd service file * run on boot * location: /lib/systemd/system/lifehack.service * status: sudo systemctl ststatus lifehack.service