Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
change using uv as recommended
  • Loading branch information
Cheukting authored Oct 29, 2024
1 parent d6f38a1 commit f9264e3
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

- [Install/ Update Rust](https://www.rust-lang.org/tools/install)
- Make sure having Python 3.8 or above (recommend 3.12)
- Make sure using virtual environment (recommend pyenv + virtualenv)
- Make sure using virtual environment (recommend using uv)

## Windows checklist

Expand All @@ -15,21 +15,26 @@ In this workshop we recommend using Unix OS (Mac or Linux). *If you use Windows,

## Setting up

1. Set up virtual environment and install **maturin**
1. Create a new working directory

```
pyenv virtualenv 3.12.2 pyo3
pyenv activate pyo3
pip install maturin
mkdir pyo3_101
cd pyo3_101
```

2. Set up virtual environment and install **maturin**

```
uv venv .venv
source .venv/bin/activate
uv pip install maturin
```

2. Start a project

If you want to start from scratch and write your own module, you can start a new project by

```
mkdir pyo3_101
cd pyo3_101
maturin init
```

Expand Down

0 comments on commit f9264e3

Please sign in to comment.