Skip to content

Commit 9ce3966

Browse files
authored
Merge pull request #465 from thedropbears/davo/readme-install-cleanup
docs: Update installation instructions
2 parents 806931d + 4ab7c5b commit 9ce3966

File tree

1 file changed

+6
-13
lines changed

1 file changed

+6
-13
lines changed

README.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# py2025
1+
# pyreefscape
22

33
The Drop Bears' robot code for FRC 2025
44

@@ -11,19 +11,14 @@ This includes the Python version, and any Python packages such as `wpilib`.
1111

1212
Install `uv` by following the [`uv` docs](https://docs.astral.sh/uv/).
1313

14-
After installing `uv`, use it to create a virtual environment and install our dependencies.
14+
After installing `uv`, download the roboRIO dependencies.
1515

1616
```sh
17-
uv sync
18-
```
19-
20-
Then, download the roboRIO dependencies.
21-
22-
```sh
23-
uv run python -m ensurepip
2417
uv run robotpy sync --no-install
2518
```
2619

20+
`uv run` will automatically create a virtual environment and install our dependencies for local development.
21+
2722
### pre-commit
2823

2924
[pre-commit][] is configured to run our formatters and linters.
@@ -33,7 +28,7 @@ To use pre-commit, you must install it outside of this project's virtual environ
3328
Either use your system package manager, or use `uv tool`:
3429

3530
```sh
36-
uv tool install pre-commit
31+
uv tool install pre-commit --with pre-commit-uv
3732
```
3833

3934
You can then set up the pre-commit hooks to run on commit:
@@ -59,15 +54,13 @@ pre-commit install
5954

6055
### Simulation
6156

62-
Before your first run, copy the `*.json.orig` files to the main directory and remove the `.orig` extension.
63-
6457
```
6558
uv run robotpy sim
6659
```
6760

6861
### Deploy to Robot
6962

70-
Once on robots network
63+
First, connect to the robot network. Then run:
7164

7265
```
7366
uv run robotpy deploy

0 commit comments

Comments
 (0)