chore: update README and CHANGELOG for clarity and structure#18
Merged
anesvijskij merged 1 commit intomainfrom Jan 22, 2026
Merged
chore: update README and CHANGELOG for clarity and structure#18anesvijskij merged 1 commit intomainfrom
anesvijskij merged 1 commit intomainfrom
Conversation
unbrokenclayman
approved these changes
Jan 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates the documentation to provide a clearer, more professional overview of the AcuMate project, its features, and its structure. The
README.mdis now focused on onboarding users and contributors, while theCHANGELOG.mdadopts a standard format and adds initial release notes.Documentation improvements:
README.md: Rewrote the introduction and feature list to clearly describe AcuMate's purpose, capabilities, and development workflow. Added sections for prerequisites, installation, repository structure, and contribution guidelines. Removed boilerplate and generic template content to focus on project-specific information.Changelog standardization:
CHANGELOG.md: Reformatted to follow Keep a Changelog and Semantic Versioning conventions, added a draft "Unreleased" section, and documented the initial public release with a summary of major features.