aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatt Strapp <matt@mattstrapp.net>2022-02-18 13:08:34 -0600
committerMatt Strapp <matt@mattstrapp.net>2022-02-18 13:08:34 -0600
commit364b4d86afc1be89b3fb010673ff70d15075604a (patch)
tree377486912c8079c0ae4971b556bb330b5642630f
parentuppercase to lowercase (diff)
downloadee4511w-364b4d86afc1be89b3fb010673ff70d15075604a.tar
ee4511w-364b4d86afc1be89b3fb010673ff70d15075604a.tar.gz
ee4511w-364b4d86afc1be89b3fb010673ff70d15075604a.tar.bz2
ee4511w-364b4d86afc1be89b3fb010673ff70d15075604a.tar.lz
ee4511w-364b4d86afc1be89b3fb010673ff70d15075604a.tar.xz
ee4511w-364b4d86afc1be89b3fb010673ff70d15075604a.tar.zst
ee4511w-364b4d86afc1be89b3fb010673ff70d15075604a.zip
Make README more accurate to new structure
Signed-off-by: Matt Strapp <matt@mattstrapp.net>
-rw-r--r--README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/README.md b/README.md
index ca93b73..dc81b01 100644
--- a/README.md
+++ b/README.md
@@ -5,11 +5,13 @@
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)
-│ ├── pendulum.py (here be dragons)
-│ └── motor.py (the motor controller)
+| ├── pendulum (folder)
+| │ ├── system.py (the main Python script)
+| │ ├── encoder.py (here be dragons)
+| │ └── motor.py (the motor controller)
├── Web (folder)
│ └── *
└── README.md (what you are currently reading)