Added readme
This commit is contained in:
28
README.md
Normal file
28
README.md
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
# MuneBase Swerve Sim
|
||||||
|
|
||||||
|
A browser-based simulator for Swerve Drive robots.
|
||||||
|
|
||||||
|
Live demo: https://swerve-vis.munebase.dev
|
||||||
|
|
||||||
|
|
||||||
|
You can host the project locally with a simple static server and open it in your browser:
|
||||||
|
|
||||||
|
- Python 3 (built-in):
|
||||||
|
|
||||||
|
python3 -m http.server 8000
|
||||||
|
|
||||||
|
Then open: http://localhost:8000
|
||||||
|
|
||||||
|
- Node.js (with npx):
|
||||||
|
|
||||||
|
npx http-server -c-1 .
|
||||||
|
|
||||||
|
Open `index.html` from the project root in your browser if your editor provides a static preview.
|
||||||
|
|
||||||
|
Notes
|
||||||
|
|
||||||
|
- Third-party scripts are in the `vendor/` directory.
|
||||||
|
|
||||||
|
License
|
||||||
|
|
||||||
|
This repository is provided as-is.
|
||||||
Reference in New Issue
Block a user