Skip to content

Commit 6c2b3c2

Browse files
updated the README.md file with instructions for the demo
1 parent 87a0679 commit 6c2b3c2

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,25 @@ make test
3939
./scripts/tests --help
4040
```
4141

42+
## Demo Program
43+
44+
A standalone demo program is included to illustrate ML-DSA usage:
45+
46+
- Generates a keypair
47+
- Signs a message
48+
- Verifies the signature
49+
50+
The demo is isolated and does not modify the main library. It works on Linux, macOS, and Windows.
51+
52+
**Build and run the demo:**
53+
54+
```bash
55+
cd demo
56+
make
57+
./demo
58+
```
59+
4260
## Contributing
4361

4462
If you want to help us build mldsa-native, please reach out. You can contact the mldsa-native team
45-
through the [PQCA Discord](https://discord.com/invite/xyVnwzfg5R).
63+
through the [PQCA Discord](https://discord.com/invite/xyVnwzfg5R).

0 commit comments

Comments
 (0)