added setup instructions

2021-02-04 09:05:51 -06:00 · 2021-02-04 09:05:51 -06:00 · cca3da5845
commit cca3da5845
parent 371fb65aec
1 changed files with 19 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -1 +1,19 @@
-# 🐱Cat 🔫Cannon
+# 🐱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
+
+