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

Create minimal CONTRIBUTING.md guide #384

Merged
merged 4 commits into from
Dec 3, 2024
Merged
Changes from all commits
Commits
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
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# 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.

The bulk of functional code is in the [`slang` repository](https://github.com/MikePopoloski/slang). Please refer to its [CONTRIBUTING.md](https://github.com/MikePopoloski/slang/blob/master/CONTRIBUTING.md) guide for more information on contributing to the core project.

## Python Bindings

Python bindings are built using [pybind11](https://github.com/pybind/pybind11).

## Documentation

All documentation is contained in the `docs` directory of the `slang` repository.

## Building and Testing

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 .
```
Loading