View the website by visiting robothandbook.dev.
Robot Concepts is a collection of animations and other documentation intended to be a visual aid when explaining robotics concepts, primarily for an FRC audience. Animations created using manim community.
This repository includes a vs-code dev container. To open the repository:
- Install docker desktop.
- Install vs-code.
- Add the Dev Containers extension to vs-code.
- Open the command Palette (Ctrl + Shift + P), and run the Dev Containers: Open Folder in Container task. Select a folder containing a local copy of this repository.
Individual animations in source may be compiled using the build script defined in build.py. To build every animation as low quality, run build from the command line.
Run build --help to see additional information on how to compile specific paths, files, or animations. Built animations will be inserted into a media folder next to the generating file in website.
The website can be built by running either make html or the vs-code build task. Note make clean may also be required to get updated versions of some files; you can verify by checking the files in build/html/_images.
Open the website by by running either python -m http.server or the vs-code open task and then opening localhost:8000 in your web browser.
To get the latest versions of animations on the website, make sure you've rebuilt the animations (using build) and the website (using make html). You will also likely need to disable the cache in your browser. To do so, press Ctrl + Shift + i to open the dev console, then go under the Network tab and choose Disable Cache, then reload the page.