From f0bd6fcb9865e8b98f07926f7a22ef25e8227290 Mon Sep 17 00:00:00 2001
From: ori agranat <oriagranat9@gmail.com>
Date: Tue, 13 Aug 2019 23:43:50 +0300
Subject: [PATCH] added read me and requirements.txt

---
 README.md                  | 81 +++++++++++++++++++++++++++++++++++++-
 backend/requirement.txt    |  3 ++
 chameleon-client/README.md |  5 +--
 3 files changed, 83 insertions(+), 6 deletions(-)
 create mode 100644 backend/requirement.txt

diff --git a/README.md b/README.md
index b12fe724d..063317104 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,80 @@
-Chameleon-Vision
+# Chameleon-Vision
+a free software for FRC teams to use for vision proccesing on their robots 
+## getting started
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
 
-https://docs.google.com/document/d/1qDuwHtpIPJfyXGIL8PJG89LZwRWbn2J9f-5g19lWL9U/edit?usp=sharing
\ No newline at end of file
+### Prerequisites
+
+so in order to run this project we will need to install python in order to run the backend and node.js with vue.js in order to run the fronted
+#### backend
+- python 3.6 and above
+- opencv 3.4.5
+- tornado web framework
+- robotpy-cscore
+- pynetworktables
+- pymq
+
+#### frontend
+- vue.js
+- vuex
+- vue-router
+- less and less-loader
+- iView
+- vue-native-websocket
+ 
+
+### installing 
+#####for the backend
+1. sudo apt-get update 
+2. apt-get dist-upgrade
+3. sudo apt-get upgrade 
+4. sudo apt-get install python3-pip python3-dev cmake zip unzip build-essential git --fix-missing
+5. sudo pip3 install numpy
+6. OPENCV_VERSION=3.4.5
+7. wget -O opencv.zip https://github.com/opencv/opencv/archive/${OPENCV_VERSION}.zip
+8. unzip opencv.zip
+9. cd ~/opencv-${OPENCV_VERSION}/
+10. mkdir build
+11. cd build
+12. cmake -D BUILD_SHARED_LIBS=ON -D BUILD_opencv_python3=ON ..
+13. make -j $(python3 -c 'import multiprocessing as mp; print(int(mp.cpu_count() * 1.5))')
+14. make install
+15. ldconfig
+16. pip3 install robotpy-cscore pyzmq tornado  
+
+to run the backend:
+```
+sudo python3 Main.py
+```
+if backed gets suck or no camera are recognized after a crash do:
+```
+sudo pkill -9 python3
+```
+
+####for the frontend
+1. sudo apt-get install nodejs npm
+2. cd chameleon-client 
+3. sudo npm install
+4. sudo npm install @vue/cli
+
+to run the front end you can open the cli ui by:
+```
+vue ui
+```
+of you can auto serve the ui by 
+```
+npm run serve
+```
+
+
+
+## docs
+main docs can be found at [google docs](https://docs.google.com/document/d/1qDuwHtpIPJfyXGIL8PJG89LZwRWbn2J9f-5g19lWL9U/edit?usp=sharing)
+
+## Authors
+* **Sagi Frimer** - *initial work* - websocket, settings manager, UI
+* **Ori Agranat** - *main coder* - vision loop , UI, websocket, networktables
+
+## Acknowledgments
+* the [robotpy project](https://github.com/robotpy) and mainly the cscore libs
+* basically all of stackoverflow
diff --git a/backend/requirement.txt b/backend/requirement.txt
new file mode 100644
index 000000000..47a0882ef
--- /dev/null
+++ b/backend/requirement.txt
@@ -0,0 +1,3 @@
+tornado
+pyzmq
+robotpy-cscore
\ No newline at end of file
diff --git a/chameleon-client/README.md b/chameleon-client/README.md
index d3a694552..b93695ec8 100644
--- a/chameleon-client/README.md
+++ b/chameleon-client/README.md
@@ -1,5 +1,5 @@
 # chameleon-client
-
+the front end project of chameleon vision 
 ## Project setup
 ```
 npm install
@@ -24,6 +24,3 @@ npm run test
 ```
 npm run lint
 ```
-
-### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).