aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md19
1 files changed, 17 insertions, 2 deletions
diff --git a/README.md b/README.md
index 301b702..5cb1a18 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,17 @@
-# ee4950-inverted-pendulum
-Code for Pi web client, embedded hardwares, and web server
+# Lamperski Inverted Pendulum
+
+[![Known Vulnerabilities](<https://snyk.io/test/github/UMN-EE4951W-Lamperski/pendulum/badge.svg>)](<https://snyk.io/test/github/UMN-EE4951W-Lamperski/pendulum>)
+
+The git repository for Professor Lamperski's Inverted Pendulum, designed by EE4951W students from 2019, 2021, and 2022.
+
+The structure for the repository is as follows:
+```
+├── System (folder)
+│ ├── system.py (the main Python script)
+│ └── motor.py (the motor controller)
+├── Web (folder)
+│ └── *
+└── README.md (what you are currently reading)
+```
+
+`*` See [the web submodule](https://github.com/UMN-EE4951W-Lamperski/pendulum-web/#README) for more information on the web frontend.