Skip to content

docs: add instructions for uv sync #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
steven-murray wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add instructions for uv sync #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,15 @@ The course textbook (in prep) is a [PDF here](/course_notes.pdf).

## Contributing

please do.
The best way to setup to write docs is to install the common environment using

```bash
uv sync
```

To install `uv` see [their documentation](https://docs.astral.sh/uv/getting-started/installation/),
which generally boils down to:

```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
```