Skip to content

Commit 3713e72

Browse files
Removal of examples to be in documented in Wiki
Update .gitignore: ensure consistency in ignoring pyCTools/bin directory Updated README to reflect the changes
1 parent 0fdb54c commit 3713e72

File tree

9 files changed

+17
-273
lines changed

9 files changed

+17
-273
lines changed

.gitattributes

Lines changed: 0 additions & 2 deletions
This file was deleted.

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,4 +115,4 @@ dmypy.json
115115
.pytype/
116116
cython_debug/
117117
/bin/
118-
/pyCTools/bin/
118+
/pyCTools/bin/

README.md

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,6 @@ This project provides a cross-language toolkit for Windows process inspection an
5656
│ └── libraryWheel/ # Library wheel files (generated by `setup.py`)
5757
│ └── *.whl # Python wheel files for library distribution via pip
5858
59-
├── examples/ # Example Python scripts demonstrating usage
60-
│ ├── hwrng_example.py # Example: Hardware RNG usage
61-
│ ├── process_inspect_example.py # Example: Process inspection usage
62-
│ └── rng_tests/ # RNG test scripts and outputs
63-
│ ├── rng_output.bin # 10M bytes of RNG data (complexity 1, threaded)
64-
│ ├── Results.txt # Test results from `rng_test.py`
65-
│ ├── rng_test.py # Script to test hardware RNG
66-
│ └── generate_bin.py # Generates binary file from RNG
67-
6859
├── pyCTools/ # Python package (library code)
6960
│ ├── bin/ # Auto-generated folder containing compiled DLL binaries
7061
│ │ ├── x86/ # 32-bit DLL builds
@@ -93,14 +84,18 @@ This project provides a cross-language toolkit for Windows process inspection an
9384
- Import and use `hwrng` or `processInspect` from `pyCTools`.
9485
- The library will automatically load the correct DLL based on your Python interpreter architecture (x86 or x64).
9586
96-
> [!TIP]
97-
> Example usages for both modules in detail:
98-
>
99-
> #### Hardware RNG
100-
> Either check out the [example script](example/hwrng_example.py) or the [Wiki page](https://github.com/DefinetlyNotAI/PyCTools/wiki/Py-Documentation-‐-hwrng#methods)
101-
>
102-
> #### Process Inspection
103-
> Either check out the [example script](example/process_inspect_example.py) or the [Wiki page](https://github.com/DefinetlyNotAI/PyCTools/wiki/Py-Documentation-‐-processInspect#methods)
87+
### Module examples and documentation
88+
89+
Example usages and documentation for both modules in detail can be found in the Wiki:
90+
91+
#### Script usage examples
92+
93+
- [Hardware RNG Example Script Wiki page](https://github.com/DefinetlyNotAI/PyCTools/wiki/Py-Documentation-‐-hwrng#proper-examples-and-tests)
94+
- [Process Inspection Example Script Wiki page](https://github.com/DefinetlyNotAI/PyCTools/wiki/Py-Documentation-‐-processInspect#example-script)
95+
96+
#### Module usage documentation
97+
- [Hardware RNG Documentation Wiki page](https://github.com/DefinetlyNotAI/PyCTools/wiki/Py-Documentation-‐-hwrng#methods)
98+
- [Process Inspection Documentation Wiki page](https://github.com/DefinetlyNotAI/PyCTools/wiki/Py-Documentation-‐-processInspect#methods)
10499
105100
### DLL Info
106101
@@ -115,6 +110,9 @@ Details about building the DLLs can be found in more detail [here](https://githu
115110
> 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:
116111
>
117112
>**DLL explanations**: learn how the DLLs are structured, discovered, and loaded
118-
>**Python examples, wrappers, and usage**: practical code snippets and usage patterns in Python
113+
>
114+
>**Python examples, wrappers, and usage**: practical code snippets and usage patterns in Python
115+
>
119116
>**C code explanation**: understand the underlying native implementation
117+
>
120118
>**Build and distribution**: how to compile, package, and distribute the libraries

example/hwrng_example.py

Lines changed: 0 additions & 9 deletions
This file was deleted.

example/process_inspect_example.py

Lines changed: 0 additions & 39 deletions
This file was deleted.

example/rng_tests/Results.txt

Lines changed: 0 additions & 40 deletions
This file was deleted.

example/rng_tests/generate_bin.py

Lines changed: 0 additions & 52 deletions
This file was deleted.

example/rng_tests/rng_output.bin

-9.54 MB
Binary file not shown.

example/rng_tests/rng_test.py

Lines changed: 0 additions & 112 deletions
This file was deleted.

0 commit comments

Comments
 (0)