Documentation/issue #582 edit readme.md#585
Open
courtneyludick wants to merge 31 commits into
Open
Conversation
Added initial content and structure for README2.md.
Added OSHWA certification details and related links.
Added references and further reading section to README2.
Added credits and mentorship information for the Krake project.
Added detailed features and specifications for the Krake wireless alarm device.
Expanded the README with detailed sections on features, hardware, firmware, and contributing guidelines. Updated the quick start instructions and added links to user and developer manuals.
Updated description of the Krake alarm device to clarify its customizable features.
Added a section explaining how the Krake alarm device works.
Added detailed navigation and settings information for the LCD UI, including planned layout, rotary encoder actions, and alarm actions. Updated credits and certification information.
Updated the README2.md to include purchasing information, build instructions, and detailed speaker specifications.
Clarified the quick start section and fixed typos.
Added licensing information for firmware and hardware.
Updated README to reflect new branding and added detailed descriptions of features and functionalities. TBC/ TBD: GPAP complete response removal of : mockingkrake esp32-wroom-32d firmware development resources
TBC comparison of rev1 & 2
ForrestErickson
requested changes
Jul 15, 2026
ForrestErickson
left a comment
ForrestErickson
left a comment
Collaborator
There was a problem hiding this comment.
This is Lee's first pass only. I became fatigued before finishing.
Put images initial images side by side
Updated product description and clarified device features.
Added an introductory paragraph about the Krake alarm device.
Revised the explanation of the name 'Krake' for clarity and humor.
Separated 'About Krake' and 'Example Use Cases' into distinct sections for clarity.
Enhanced the explanation of how the device works, providing more detail on sensor detection and user interaction with alarms.
Added a Table of Contents and updated user manual references.
Removed redundant alarm queue indication from the LCD User Interface feature description.
Removed firmware section and example GPAP responses from README.
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.
Links
Artifacts (attach if relevant)
Checklist
check for ? in documentation