-
Notifications
You must be signed in to change notification settings - Fork 3
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
c7f953c
commit 279abb9
Showing
1 changed file
with
3 additions
and
19 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,36 +1,20 @@ | ||
# Wombat Docs | ||
|
||
The documentation for 4788s wombat library. | ||
Documentation to help 4788 programmers learn how to write FRC code. | ||
|
||
> [!IMPORTANT] | ||
> View the production version of the documentation here: [https://4788-docs.vercel.app/](https://4788-docs.vercel.app/) | ||
## Contributing | ||
|
||
If you would like to contribute to the documentation, please fork the repository and make a pull request into the master branch here: [https://github.com/CurtinFRC/Wombat-Docs.git](https://github.com/CurtinFRC/Wombat-Docs.git). | ||
|
||
## Running | ||
|
||
To run the documentation locally, you will need pnpm (or equivalent) installed. Then run the following commands: | ||
|
||
|
||
To run the documentation locally, you will need pnpm installed. Then run the following commands: | ||
```bash | ||
pnpm install | ||
pnpm run dev | ||
``` | ||
|
||
## Building | ||
|
||
To build the documentation, you will need pnpm (or equivalent) installed. Then run the following commands: | ||
|
||
To build the documentation, you will need pnpm installed. Then run the following commands: | ||
```bash | ||
pnpm install | ||
pnpm run build | ||
``` | ||
|
||
The built documentation will be in the `dist` directory. | ||
|
||
You can find the most updated code for wombat in our [GitHub repository](https://github.com/CurtinFRC/2024-Crescendo). Wombat will be located in the `wombat` directory of the repository. | ||
|
||
> [!NOTE] | ||
> You can also find a less up to date version of wombat in a separate repository [here](https://github.com/CurtinFRC/Wombat) |