Skip to content

Commit 3084ec1

Browse files
committed
docs: update README.md
1 parent 7aad748 commit 3084ec1

1 file changed

Lines changed: 10 additions & 27 deletions

File tree

README.md

Lines changed: 10 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -11,29 +11,16 @@ Generate C++ headers from DWARF Debugging Information Format (DWARF), targeting
1111
> publicly available for Minecraft: Bedrock Edition. You must first have access to debug-enabled binaries. This
1212
> tool cannot generate any useful output without them.
1313
14-
---
15-
1614
## Installation
1715

18-
dwarf2cpp is a standard Python package.
19-
20-
### Requirements
21-
22-
* **Python 3.9+**
23-
* **C++ Compiler**
24-
Since dwarf2cpp uses a **pybind11 binding for LLVM's DWARF DebugInfo module**, you need a working C++ toolchain to
25-
build it:
26-
27-
* On Windows: **MSVC (Visual Studio Build Tools)**
28-
* On Linux: **GCC (g++)**
29-
* On macOS: **Apple Clang (Xcode Command Line Tools)**
30-
* **CMake** (required to configure and build the native extension)
31-
* **LLVM with DWARF DebugInfo libraries** available (either pre-installed or fetched by the build process, depending on
32-
your setup).
16+
### Build from Sources
3317

34-
Make sure your compiler and CMake are available on your system `PATH` before installation.
18+
Since dwarf2cpp uses **pybind11** to use LLVM's DWARF DebugInfo module from Python, you need a working C++ toolchain to
19+
build it:
3520

36-
### Build from Sources
21+
* On Windows: **MSVC (Visual Studio Build Tools)**
22+
* On Linux: **GCC (g++)**
23+
* On macOS: **Apple Clang (Xcode Command Line Tools)**
3724

3825
```
3926
git clone https://github.com/yourusername/dwarf2cpp.git
@@ -95,13 +82,10 @@ python -m dwarf2cpp path/to/bedrock_server --base-dir /mnt/vss/_work/1/s
9582

9683
## Motivation / Purpose
9784

98-
Minecraft: Bedrock Edition does not provide public headers for its binaries, making modding more difficult.
99-
This project exists to bridge that gap by reconstructing usable C++ headers directly from DWARF debug information.
100-
10185
Typical use cases include:
10286

10387
* Analysing the internals of Minecraft: Bedrock Edition.
104-
* Supporting plugin frameworks such as **[Endstone](https://github.com/EndstoneMC/endstone)**.
88+
* Supporting the development of plugin frameworks such as **[Endstone](https://github.com/EndstoneMC/endstone)**.
10589
* Research on automated source reconstruction from DWARF.
10690

10791
## Limitations
@@ -131,11 +115,10 @@ This project makes use of the following open source technologies:
131115
132116
## Contributing
133117

134-
Contributions are welcome! If you encounter issues or have suggestions for improvements, please open an issue or a pull
135-
request on GitHub.
136-
When contributing code, please ensure that your changes are well-documented and tested.
118+
Contributions are welcome!
119+
If you encounter issues or have suggestions for improvements, please open an issue or a pull request on GitHub.
137120

138121
## License
139122

140123
This project is distributed under the MIT License.
141-
See the [LICENSE] file for more details.
124+
See the [LICENSE](LICENSE) file for more details.

0 commit comments

Comments
 (0)