Skip to content

Commit

Permalink
Merge pull request #5 from SciBorgs/codespace-readme
Browse files Browse the repository at this point in the history
update readme
  • Loading branch information
sigalrmp authored Jan 23, 2025
2 parents c80543e + 28fb2da commit e180cad
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,5 @@
"java": "17"
},
"postCreateCommand": "mkdir -p /home/vscode/.vscode-remote/extensions && cd /home/vscode && curl -L -o .vscode-remote/extensions/vscode-wpilib-2024.3.2.vsix https://github.com/wpilibsuite/vscode-wpilib/releases/download/v2024.3.2/vscode-wpilib-2024.3.2.vsix",
"postAttachCommand": "code --install-extension /home/vscode/.vscode-remote/extensions/vscode-wpilib-2024.3.2.vsix && git remote add origin https://github.com/SciBorgs/SciGuidesRobotBase && git fetch"
"postAttachCommand": "code --install-extension /home/vscode/.vscode-remote/extensions/vscode-wpilib-2024.3.2.vsix"
}
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
# SciGuides Robot Base

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?template_repository=SciBorgs/SciGuidesRobotBase)

This is the base repository used for projects in [SciGuides](https://github.com/SciBorgs/SciGuides). It is based on [Hydrogen](https://github.com/SciBorgs/Hydrogen), the base repository for the SciBorgs.

This repository is a *template*. To create your own repo from this template (i.e. for a SciGuides project), follow [these instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template#creating-a-repository-from-a-template).

## Codespaces

You can work on your robot code using github codespaces! This will allow you to develop and contribute from any computer, without worrying about installing anything.

To create a new codespace, press on the arrow below the green `Code` button and open the Codespaces tab. Then press `Create codespace on main`.

Between uses, make sure to stop your codespace! Open the Codespaces tab again, press the three dots next to your codespace, and press `stop codespace`. Then, when you want to use it again, just click on the codespace and it'll reopen!

0 comments on commit e180cad

Please sign in to comment.