Skip to content
This repository has been archived by the owner on Jan 18, 2025. It is now read-only.

Commit

Permalink
Add missing 'Building and Testing' guide
Browse files Browse the repository at this point in the history
  • Loading branch information
parker-research committed Dec 2, 2024
1 parent 3457175 commit fe7bafe
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contibuting to `pyslang`
# Contributing to `pyslang`

Pyslang, the Python bindings for the [slang project](https://github.com/MikePopoloski/slang), are built, tested, and packaged with code in this repository.

Expand All @@ -14,4 +14,22 @@ All documentation is contained in the `docs` directory of the `slang` repository

## Building and Testing

TODO: Write step-by-step instructions to build and test the bindings.
1. Clone the `pyslang` repository (https://github.com/MikePopoloski/pyslang)
2. Clone the `slang` submodule:

```bash
git submodule update --init --recursive
```

3. Optionally, create a virtual environment and activate it.

```bash
python3 -m venv venv
source venv/bin/activate
```

4. Install `pyslang` as a Python package (including building the C++ `slang` library with bindings, from the submodule):

```bash
pip install .
```

0 comments on commit fe7bafe

Please sign in to comment.