From cca3da58455e49b7e9ca08c6b1f62b65c1206784 Mon Sep 17 00:00:00 2001 From: ysandler Date: Thu, 4 Feb 2021 09:05:51 -0600 Subject: [PATCH] added setup instructions --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 16f4cbb..fd004fd 100644 --- a/README.md +++ b/README.md @@ -1 +1,19 @@ -# 🐱Cat 🔫Cannon \ No newline at end of file +# 🐱Cat 🔫Cannon + +The Cat Cannon is an automatically aiming water cannon designed to keep cats out of any location in which there presence is not desired. This solution is built on top of the Raspberry Pi driven by TypeScript and very little Python. + +## Software Setup + + Clone this repo and navigate to its saved directory + + npm install + + ts-node ./src/Robitics/main.ts + + open a browser at http://localhost:5005 + + wait for cat to enter view of camera + + what the machine protect your assets + +