Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documented git submodules for building #295

Closed
wants to merge 5 commits into from
Closed

Conversation

phklive
Copy link
Contributor

@phklive phklive commented Mar 22, 2024

In this PR I propose the addition of documentation to the README.md file of this repo. Documenting the need to use git submodules to be able to build Miden crypto because of the dependency on https://github.com/PQClean/PQClean

Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

Copy link
Contributor

@hackaugusto hackaugusto left a comment

Choose a reason for hiding this comment

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

LGTM

@bobbinth
Copy link
Contributor

One note: in the current next we actually don't use submodules any more. Thought, they may come back after #293.

@phklive
Copy link
Contributor Author

phklive commented Mar 22, 2024

One note: in the current next we actually don't use submodules any more. Thought, they may come back after #293.

Should we close this PR then or should we merge it in case it's needed in the future?

@bobbinth
Copy link
Contributor

I'd keep it open but wouldn't merge yet. After we figure how #293 is going to work, we'll either merge or close this.

@bobbinth bobbinth force-pushed the next branch 2 times, most recently from ea484e6 to 43fe7a1 Compare April 21, 2024 08:27
@bobbinth
Copy link
Contributor

Closing this as stale as we probably no longer need the submodules functionality here.

@bobbinth bobbinth closed this Aug 18, 2024
@bobbinth bobbinth deleted the phklive-git-submodules branch October 18, 2024 06:50
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.

4 participants