Skip to content

Commit 7fe3a9d

Browse files
Update README.md: add installation instructions for pyCTools library
1 parent 538ead9 commit 7fe3a9d

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,19 @@
66
<img src="https://img.shields.io/github/v/tag/DefinetlyNotAI/PyCTools" alt="Version" />
77
</div>
88

9+
> [!NOTE]
10+
> There are multiple ways to install the pyCTools library!
11+
>
12+
> * **Manual installation:**
13+
>
14+
> 1. Clone the repository and build the DLLs yourself.
15+
> 2. Run `python ./tools/setup.py bdist_wheel` to create the wheel file.
16+
> 3. The setup script will show you how to install the package locally with pip and how to create a virtual environment for testing.
17+
> * **Automatic installation:**
18+
> Go to the [releases page](https://github.com/DefinetlyNotAI/PyCTools/releases) and select the version you wish to install, and click on it, then copy the top `pip` command that will allow you to install it
19+
> [Auto installation support from v0.2.0-beta and above]
20+
21+
922
This project provides a cross-language toolkit for Windows process inspection and hardware random number generation, with both Python and C components. It includes:
1023

1124
- **Python library (`pyCTools`)**: Easy-to-use wrappers for native DLLs to access process metrics and hardware RNG.

0 commit comments

Comments
 (0)