Create README.md

jyjblrd · Nov 8, 2023 · e6ab9ed · e6ab9ed
1 parent 590a3c4
commit e6ab9ed
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,10 @@
+# Mocap Drones
+
+### A general purpose motion capture system built from the ground up, used to autonomously fly multiple drones indoors
+
+## Runing the code
+Run `yarn run install` to install node dependencies 
+
+Then run `yarn run dev` to start the webserver. You will be given a url view the frontend interface.
+
+In another terminal window, run `python3 api/index.py` to start the backend server. This is what receives the camera streams and does motion capture computations.