Skip to content

Conversation

keshavgarg5130
Copy link

Overview

This PR introduces a minimal, standalone demo program to demonstrate the basic usage of ML-DSA (mode 3) for keypair generation, message signing, and signature verification.

Changes

  • Added a new demo/ folder at the root of the repository.
  • demo/ contains:
    • demo.c — the example program.
    • Makefile — to compile and run the demo easily on Linux/macOS/Windows.
  • The demo is isolated and does not modify any existing ML-DSA source files.
  • Uses the library as intended through the public API (api.h).
  • Updated the README.md file to include the instructions to run the demo program.

Motivation

  • Provides a working example for beginners to quickly understand ML-DSA usage.
  • Keeps the core repository untouched while adding educational value.
  • Helps in testing the library without touching the main build system.

How to Build and Run

cd demo
make
./demo

Tested On

  • macOS (Apple Silicon, arm64)

Notes

  • No functionality of the main library is changed.
  • The demo supports cross-platform compilation for Linux/macOS/Windows.

@keshavgarg5130 keshavgarg5130 requested a review from a team as a code owner August 25, 2025 19:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant