-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7489c47
commit cf8c980
Showing
2 changed files
with
6 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,22 @@ | ||
# Robot Concepts | ||
|
||
[![Build and Deploy](https://github.com/robot-education/robot-handbook/actions/workflows/gh-pages-deploy.yml/badge.svg?branch=main)](https://github.com/robot-education/robot-handbook/actions/workflows/gh-pages-deploy.yml) | ||
|
||
View the website by visiting [robothandbook.dev](https://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](https://www.manim.community/). | ||
|
||
## Development | ||
<!-- ## Development | ||
This repository includes a vs-code dev container. To open the repository: | ||
1. Install [docker desktop](https://www.docker.com/products/docker-desktop/). | ||
2. Install [vs-code](https://code.visualstudio.com/download). | ||
3. Add the **Dev Containers** extension to vs-code. | ||
4. 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. | ||
4. 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. --> | ||
|
||
### Build | ||
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](localhost:8000/) in your web browser. | ||
Individual animations in `source` may be compiled using the build script defined in `library/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`. | ||
|
||
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. | ||
The website can be built by running the vs-code **dev-server** task and opening [localhost:8000](http:://localhost:8000) in your web browser. |
This file was deleted.
Oops, something went wrong.