Skip to content

Commit 1f1b351

Browse files
authored
Merge pull request #84 from gdsfactory/add_uv
add uv instructions
2 parents e88f49c + 014d1ff commit 1f1b351

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,25 @@ Then you need to restart Klayout to make sure the new technology installed appea
2323

2424
You can download the [code](https://github.com/gdsfactory/cspdk/archive/refs/heads/main.zip) and examples.
2525

26-
### Installation for developers
26+
### Installation for contributors
2727

28-
For developers you need to `git clone` the GitHub repository, fork it, git add, git commit, git push and merge request your changes.
28+
We recommend `uv`
2929

30+
```bash
31+
# On macOS and Linux.
32+
curl -LsSf https://astral.sh/uv/install.sh | sh
3033
```
31-
git clone https://github.com/gdsfactory/cspdk.git
32-
cd cspdk
33-
pip install -e . pre-commit
34-
pre-commit install
35-
python install_tech.py
34+
35+
```bash
36+
# On Windows.
37+
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
38+
```
39+
40+
Then you can install with:
41+
42+
```bash
43+
uv venv --python 3.11
44+
uv sync --extra docs --extra dev
3645
```
3746

3847
## Documentation

0 commit comments

Comments
 (0)