Skip to content

Commit 8bf47bd

Browse files
committed
Update README: fix warning syntax, point wheels to Releases, add Releasing section
1 parent 134bfe4 commit 8bf47bd

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
Generate C++ headers from DWARF Debugging Information Format (DWARF).
88

9-
> \[!WARNING]
9+
> [!WARNING]
1010
> This tool requires binaries that contain **DWARF debug information** in order to generate headers.
1111
> Make sure your input binary includes DWARF debug info, which is often not publicly available in proprietary software.
1212
@@ -34,20 +34,16 @@ python -m dwarf2cpp
3434

3535
### Prebuilt Wheels
3636

37-
For convenience, **prebuilt wheels** are available from the GitHub Actions pages of this repository.
38-
These wheels include the required C++ extension, so you do not need to have LLVM or a compiler toolchain installed
39-
locally.
37+
Prebuilt wheels are attached to each [GitHub Release](https://github.com/EndstoneMC/dwarf2cpp/releases).
38+
These include the compiled C++ extension, so you do not need LLVM or a compiler toolchain.
4039

41-
1. Visit the **Actions** tab on GitHub.
42-
2. Select the latest successful build for your platform (Windows, Linux, or macOS).
43-
3. Download the wheel artifact and install it with:
40+
1. Download the `.whl` for your platform from the latest release
41+
2. Install it:
4442

4543
```
4644
pip install dwarf2cpp-<version>-<platform>.whl
4745
```
4846

49-
This is the recommended option if you only want to use `dwarf2cpp` without setting up a compiler or LLVM.
50-
5147
## Usage
5248

5349
```
@@ -112,10 +108,20 @@ This project makes use of the following open-source technologies:
112108
> Do not redistribute or publish headers generated from proprietary binaries without proper rights.
113109
> Respect the terms of service and licensing agreements of any binaries you analyse.
114110
111+
## Releasing
112+
113+
1. Add changes under `## [Unreleased]` in `CHANGELOG.md`
114+
2. Go to **Actions > Release > Run workflow**
115+
3. Enter the version (e.g. `0.2.0`) and run
116+
117+
The workflow validates the version, updates pyproject.toml and CHANGELOG.md, creates a git tag
118+
and GitHub release, builds wheels on all platforms, and attaches them to the release.
119+
120+
Use **dry run** to preview without making changes.
121+
115122
## Contributing
116123

117-
Contributions are welcome!
118-
If you encounter issues or have suggestions for improvements, please open an issue or a pull request on GitHub.
124+
Contributions are welcome. Open an issue or pull request on GitHub.
119125

120126
## License
121127

0 commit comments

Comments
 (0)