Skip to content

Wip improve docs #13

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.

Sign up for GitHub

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

Jump to bottom
Merged
douglasichen merged 5 commits into from
Oct 23, 2025
Merged

Wip improve docs #13

douglasichen merged 5 commits into from
Oct 23, 2025

Conversation

@douglasichen
Copy link
Contributor

@douglasichen douglasichen commented Oct 21, 2025

  1. add clone instruction
  2. add common lib installation instructions
  3. change external lib submodules name to conventional submodules folder name
  4. add testing docs

@douglasichen douglasichen self-assigned this Oct 21, 2025
@douglasichen douglasichen linked an issue Oct 21, 2025 that may be closed by this pull request
Improve documentation #9
Closed
@douglasichen douglasichen requested a review from Roozki October 21, 2025 02:38
Roozki
Roozki reviewed Oct 21, 2025
View reviewed changes
.gitmodules
[submodule "external_libs/Catch2"]
path = external_libs/Catch2
[submodule "submodules/Catch2"]
path = submodules/Catch2
Copy link
Contributor

@Roozki Roozki Oct 21, 2025

Choose a reason for hiding this comment

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

👍

Roozki
Roozki approved these changes Oct 21, 2025
View reviewed changes
Copy link
Contributor

@Roozki Roozki left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Looks good, thanks for doing this!!
Approving assuming this is complete, but feel free to add small changes without requesting another review.

@douglasichen douglasichen merged commit fbbc652 into main Oct 23, 2025
1 check passed
@douglasichen douglasichen deleted the wip-improve-docs branch October 23, 2025 05:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Roozki Roozki Roozki approved these changes

Assignees

@douglasichen douglasichen

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Improve documentation

3 participants

@douglasichen @Roozki