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

#39: update README #59

Merged
merged 15 commits into from
Sep 21, 2024
Merged

#39: update README #59

merged 15 commits into from
Sep 21, 2024

Conversation

pierrepebay
Copy link
Contributor

@pierrepebay pierrepebay commented Sep 20, 2023

Fixes: #39

Merge after #85

This PR adds a better README and small code improvements (e.g. standardizing capitalization of QOI in function names).

Does NOT deploy documentation using Doxygen (that will be done in #112)

@pierrepebay pierrepebay added documentation Improvements or additions to documentation Low priority To be addressed after high priority labels Sep 20, 2023
@pierrepebay pierrepebay self-assigned this Sep 20, 2023
@pierrepebay pierrepebay linked an issue Sep 20, 2023 that may be closed by this pull request
@tlamonthezie tlamonthezie force-pushed the 39-add-documentation branch from cdbf429 to 1a78755 Compare June 28, 2024 11:53
@cwschilly cwschilly force-pushed the 39-add-documentation branch from b647615 to 5dae984 Compare July 17, 2024 17:25
README.md Outdated Show resolved Hide resolved
@cwschilly cwschilly self-assigned this Jul 18, 2024
README.md Show resolved Hide resolved
@cwschilly cwschilly force-pushed the 39-add-documentation branch from 3887550 to 2840d22 Compare August 26, 2024 18:30
@cwschilly cwschilly marked this pull request as ready for review September 12, 2024 19:28
@tlamonthezie tlamonthezie mentioned this pull request Sep 16, 2024
@cwschilly cwschilly changed the title #39: add documentation #39: update README Sep 18, 2024
@cwschilly cwschilly requested a review from ppebay September 19, 2024 17:30
Copy link
Contributor

@ppebay ppebay left a comment

Choose a reason for hiding this comment

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

Excellent documentation work @cwschilly
Only minor stylistic changes requested.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@cwschilly cwschilly requested a review from ppebay September 19, 2024 20:16
Copy link
Contributor

@ppebay ppebay left a comment

Choose a reason for hiding this comment

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

Thanks for the changes @cwschilly

@ppebay ppebay merged commit 8a66113 into master Sep 21, 2024
8 checks passed
@ppebay ppebay deleted the 39-add-documentation branch September 21, 2024 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Low priority To be addressed after high priority
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update README
4 participants