Skip to content

add uv instructions #84

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

Merged
joamatab merged 1 commit into from
Dec 12, 2024
Merged

add uv instructions #84

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
23 changes: 16 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,25 @@ Then you need to restart Klayout to make sure the new technology installed appea

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

### Installation for developers
### Installation for contributors

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

```bash
# On macOS and Linux.
curl -LsSf https://astral.sh/uv/install.sh | sh
```
git clone https://github.com/gdsfactory/cspdk.git
cd cspdk
pip install -e . pre-commit
pre-commit install
python install_tech.py

```bash
# On Windows.
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```

Then you can install with:

```bash
uv venv --python 3.11
uv sync --extra docs --extra dev
```

## Documentation
Expand Down