Skip to content

Commit f32d60d

Browse files
committed
Clean up README: remove black reference and update legacy section
- Removed black from feature list (replaced with ruff for formatting) - Updated legacy section to remove outdated deps_rocker references - Clarified that ruff handles both formatting and linting
1 parent f67a4c9 commit f32d60d

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ A template repo for python projects that is set up using [pixi](https://pixi.sh)
44
This has basic setup for
55

66
* pylint
7-
* ruff
8-
* black
7+
* ruff (formatting and linting)
98
* pytest
109
* git-lfs
1110
* basic github actions ci
@@ -77,7 +76,7 @@ pixi run ci
7776

7877
## Legacy
7978

80-
If you don't want to install rocker on your system but want to use vscode, you can run the `scripts/launch_vscode.sh` script to build and connect to a docker container. It will install rocker in a venv. The docker container is dynamically generated using [rocker](https://github.com/osrf/rocker) and [deps rocker](https://github.com/blooop/deps_rocker). [deps rocker](https://github.com/blooop/deps_rocker) looks at the python_template.deps.yaml file to install any required apt, pip or shell scripts and launches a container that vscode attaches to.
79+
If you don't want to install rocker on your system but want to use vscode, you can run the `scripts/launch_vscode.sh` script to build and connect to a docker container. It will install rocker in a venv. The docker container is dynamically generated using [rocker](https://github.com/osrf/rocker) and the configuration in `rockerc.yaml`.
8180

8281
## Troubleshooting
8382

0 commit comments

Comments
 (0)