Skip to content

Commit cb6ea5b

Browse files
authored
chore: enhance README with build instructions
Added build instructions for MSVC, Clang, and GCC.
1 parent 6a4b8a0 commit cb6ea5b

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
**ntstrings** is a string extraction tool for Windows. Designed as a high-performance alternative to standard tools like Sysinternals `strings`, `bstrings`, `xxstrings`, `strings2`, etc.
44

55
For a more in-depth explanation of the scanning approach, see the [architecture documentation](https://github.com/NotRequiem/ntstrings/blob/master/architecture.md).
6+
67
# Usage
78

89
```text
@@ -84,3 +85,19 @@ Load a list of malicious strings/indicators from a text file and check an execut
8485
```cmd
8586
ntstrings -fs malicious_iocs.txt suspect.exe
8687
```
88+
89+
# Build
90+
> For MSVC or LLVM clang-cl, just open the .sln file located at the root of this repository and click on "**Build**".
91+
92+
> For Clang or GCC, use CMake, located inside the nstrings folder.
93+
94+
Example on Clang:
95+
```cmd
96+
cmake -B build -G "Ninja" ^
97+
-DCMAKE_C_COMPILER=clang ^
98+
-DCMAKE_CXX_COMPILER=clang++ ^
99+
-DCMAKE_BUILD_TYPE=Release
100+
101+
cmake --build build --config Release
102+
```
103+
<img width="703" height="389" alt="image" src="https://github.com/user-attachments/assets/0695f09b-ff1d-4c95-85b4-a7bbde6677ab" />

0 commit comments

Comments
 (0)