Skip to content

Update README with current implementations and prerequisites#128

Merged
SoraSuegami merged 1 commit into
mainfrom
codex/update-readme-0602
Jun 2, 2026
Merged

Update README with current implementations and prerequisites#128
SoraSuegami merged 1 commit into
mainfrom
codex/update-readme-0602

Conversation

@SoraSuegami

Copy link
Copy Markdown
Member

Summary

  • Rewrote the README to describe the current lattice-crypto scope of mxx and the major implementation areas in the repo.
  • Added a paper-to-directory mapping for BGG+, WEE25 matrix commitment, BGG+ lookup-table evaluation, GSW-FHE evaluation/decryption, AKY24-based benchmark estimation, and Diamond iO benchmark estimation.
  • Updated prerequisites and Cargo feature notes, including the OpenFHE fork requirement and GPU/CUDA build expectations.

Testing

  • Not run (not requested)
  • Performed documentation-only validation during editing: diff whitespace checks, path checks, and metadata-level review of the referenced features and directories.

@SoraSuegami SoraSuegami merged commit 88dd754 into main Jun 2, 2026
2 checks passed
@SoraSuegami SoraSuegami deleted the codex/update-readme-0602 branch June 2, 2026 05:04

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 312d92bead

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
Run a targeted unit test by name when validating a narrow change:

```sh
cargo test <test_name>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Restrict the unit-test command to the library target

I checked cargo test --help; it describes cargo test as executing all unit and integration tests, and lists --lib as testing only the package library. In this repo, integration tests are explicitly gated unless requested, so documenting cargo test <test_name> under “targeted unit test” can still compile and run matching tests from tests/; use cargo test --lib <test_name> or a specific --test command only when integration tests are approved.

Useful? React with 👍 / 👎.

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