Skip to content
This repository was archived by the owner on Mar 26, 2026. It is now read-only.

Commit 1c4a6a1

Browse files
Update README.md
1 parent 4608d7a commit 1c4a6a1

File tree

1 file changed

+37
-18
lines changed

1 file changed

+37
-18
lines changed

README.md

Lines changed: 37 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,38 @@ This project provides a cross-language toolkit for Windows process inspection an
77
- **Example Python scripts**: Demonstrate usage of the library.
88
- **PowerShell build helper**: Automates DLL compilation for x86/x64.
99

10+
> [!IMPORTANT]
11+
> To get the `dist` binary folder, choose **one** of the following options:
12+
>
13+
> | Method | Description | Requirements |
14+
> |-----------------------------|--------------------------------------------------------------------------------------------------|----------------------------------------------------------------|
15+
> | Manual Build | Compile the binaries yourself using `cl.exe` or similar toolchains | Microsoft Visual Studio with MSVC installed |
16+
> | Auto Build Script | Run the [`tool/compilerHelper.ps1`](https://github.com/DefinetlyNotAI/PyCTools/blob/main/tool/compilerHelper.ps1) PowerShell script | Visual Studio Build Tools + PowerShell |
17+
> | Prebuilt Release Archive | Download precompiled binaries from the [releases page](https://github.com/DefinetlyNotAI/PyCTools/releases/tag/v1.0.0) | None (just extract archive) |
18+
>
19+
> No matter what you decide, do still read the important notice about the `dist` from the [release](https://github.com/DefinetlyNotAI/PyCTools/releases/tag/v1.0.0) OR check the [Wiki](https://github.com/DefinetlyNotAI/PyCTools/wiki/DLL-Discovery) page about the DLL discovery explanation.
20+
1021
## Directory Structure
1122

12-
```
13-
example/
14-
pyCTools/
15-
hwrng.py # Python wrapper for hardware RNG DLL
16-
processInspect.py # Python wrapper for process inspection DLL
17-
hwrng_example.py # Example: hardware RNG usage
18-
process_inspect_example.py # Example: process metrics usage
19-
src/
20-
hRng.c # C source for hardware RNG DLL
21-
processInspect.c # C source for process inspection DLL
22-
tool/
23-
compilerHelper.ps1 # PowerShell script to build DLLs for x86/x64
24-
dist/
25-
x64/ # Compiled DLLs for 64-bit
26-
x86/ # Compiled DLLs for 32-bit
27-
```
23+
<details>
24+
<summary>📁 Project Structure (click to expand)</summary>
25+
26+
example/
27+
pyCTools/
28+
hwrng.py # Python wrapper for hardware RNG DLL
29+
processInspect.py # Python wrapper for process inspection DLL
30+
hwrng_example.py # Example: hardware RNG usage
31+
process_inspect_example.py # Example: process metrics usage
32+
src/
33+
hRng.c # C source for hardware RNG DLL
34+
processInspect.c # C source for process inspection DLL
35+
tool/
36+
compilerHelper.ps1 # PowerShell script to build DLLs for x86/x64
37+
dist/
38+
x64/ # Compiled DLLs for 64-bit
39+
x86/ # Compiled DLLs for 32-bit
40+
41+
</details>
2842

2943
## Building the DLLs
3044

@@ -65,7 +79,12 @@ The Python wrappers automatically search for the correct DLL in:
6579

6680
where `{arch}` is `x64` or `x86` depending on your Python interpreter.
6781

68-
## License
82+
## Extra resources
6983

70-
MIT or specify your license here.
84+
> [!TIP]
85+
> Want to dive deeper into how everything works? Head over to the [PyCTools Wiki](https://github.com/DefinetlyNotAI/PyCTools/wiki) for detailed breakdowns of the key parts:
86+
>
87+
> **DLL explanations**: learn how the DLLs are structured, discovered, and loaded
88+
> **Python examples, wrappers, and usage**: practical code snippets and usage patterns in Python
89+
> **C code explanation**: understand the underlying native implementation
7190

0 commit comments

Comments
 (0)