Skip to content

Commit 7ed9eff

Browse files
docs(README): improve formatting and update contribution details
1 parent 777be4e commit 7ed9eff

1 file changed

Lines changed: 14 additions & 8 deletions

File tree

‎README.md‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,24 @@
77
You need [uv](https://docs.astral.sh/uv/) and a Python that satisfies `>=3.11`.
88

99
1. Create a virtual environment with a fixed Python version (run this in the directory where you want `.venv`, e.g. the repo root for a clone):
10-
```bash
10+
11+
```bash
1112
uv venv --python 3.11 # or 3.12 or 3.13
12-
```
13+
```
14+
1315
2. Activate it. On Linux or macOS:
14-
```bash
16+
17+
```bash
1518
source .venv/bin/activate
16-
```
19+
```
20+
1721
On Windows, use `.venv\Scripts\activate` (cmd) or `.\.venv\Scripts\Activate.ps1` (PowerShell).
22+
1823
3. Install into that environment, using the published package from PyPI:
19-
```bash
24+
25+
```bash
2026
uv pip install dynamicsyntax
21-
```
27+
```
2228

2329
## Examples
2430

@@ -36,7 +42,7 @@ print(p.vis()) # Visualise the parse tree
3642

3743
## Get Involved
3844

39-
Contributions (issues, PRs, [donations (spent on coffee/LLM credits!)](https://buymeacoffee.com/incrementaliser)) are very welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
45+
Contributions (issues, PRs, [donations (for coffee or LLM credits!)](https://buymeacoffee.com/incrementaliser)) are very welcome! Please see [CONTRIBUTING.md](docs/CONTRIBUTING.md) for more details.
4046

4147
**Note**
42-
Since this project has been translated using Cursor and tested only on Windows, there is a small chance errors exist. I would be grateful if you could report them to me through the above channels. Although, it is important to mention that some of the most critical methods here have been verified via unit tests, so there is a high chance the migration from Java has been correct so far.
48+
Since this project has been translated using Cursor and tested only on Windows, there is a small chance errors exist. I would be grateful if you could report them to me through the above channels. Although, it is important to mention that some of the most critical methods here have been verified via unit tests, so there is a high chance the migration from Java has been correct so far.

0 commit comments

Comments
 (0)