Skip to content

Commit fce6bdd

Browse files
committed
docs tweaks
1 parent 3a8d5d7 commit fce6bdd

File tree

2 files changed

+17
-11
lines changed

2 files changed

+17
-11
lines changed

README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -72,20 +72,21 @@ Pydust supports:
7272

7373
Please reach out if you're interested in helping us to expand compatibility.
7474

75-
## Getting Started
75+
## Resources
7676

7777
Pydust docs can be found [here](https://pydust.fulcrum.so).
78+
7879
Zig documentation (beta) can be found [here](https://pydust.fulcrum.so/latest/zig).
7980

80-
There is also a [template repository](https://github.com/fulcrum-so/ziggy-pydust-template) including Poetry build, Pytest and publishing from Github Actions.
81+
There is also a [template repository](https://github.com/fulcrum-so/ziggy-pydust-template) including Poetry build, Pytest, and publishing from Github Actions.
8182

8283
## Contributing
8384

8485
We welcome contributions! Pydust is in its early stages so there is lots of low hanging
85-
fruit when it comes to contributions.
86+
fruit when it comes to contributions. If you are interested in contributing, please feel free to:
8687

8788
- Assist other Pydust users with GitHub issues or discussions.
88-
- Suggest or implement features, fix bugs, fix performance issues.
89+
- Suggest or implement features, fix bugs, or fix performance issues.
8990
- Improve our documentation.
9091
- Write articles or other content demonstrating how you have used Pydust.
9192

docs/getting_started.md

+12-7
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,25 @@ By far the easiest way to get started is by creating a project from our GitHub t
1010

1111
This template includes:
1212

13-
- A Python Poetry project
14-
- A `src/` directory containing a Pydust Python module
15-
- Pytest setup for running both Python and Zig unit tests.
16-
- GitHub Actions workflows for building and publishing the package.
17-
- VSCode settings for recommended extensions, debugger configurations, etc.
13+
* A Python Poetry project
14+
* A `src/` directory containing a Pydust Python module
15+
* Pytest setup for running both Python and Zig unit tests
16+
* GitHub Actions workflows for building and publishing the package
17+
* VSCode settings for recommended extensions, debugger configurations, etc.
1818

1919
## Poetry Setup
2020

2121
Assuming you have an existing Poetry project, these are the changes you need to make to
22-
your `pyproject.toml` to setup Ziggy Pydust. But first, add Pydust as a dev dependency:
22+
your project to setup Ziggy Pydust.
23+
24+
First, add Pydust as a dev dependency:
2325

2426
```bash
2527
poetry add -G dev ziggy-pydust
2628
```
2729

30+
Second, make the following additions to your existing `pyproject.toml`:
31+
2832
```diff title="pyproject.toml"
2933
[tool.poetry]
3034
name = "your-package"
@@ -40,7 +44,8 @@ packages = [ { include = "your-module" } ]
4044
build-backend = "poetry.core.masonry.api"
4145
```
4246

43-
As well as creating the `build.py` for Poetry to invoke the Pydust build.
47+
Finally, for Poetry to invoke the Pydust build create a `build.py` file in the same directory
48+
as `pyproject.toml` with the following contents:
4449

4550
```python title="build.py"
4651
from pydust.build import build

0 commit comments

Comments
 (0)