Uh oh!
There was an error while loading. Please reload this page.
Documentation/issue #582 edit readme.md - #585
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
left a comment
There was a problem hiding this comment.
This is Lee's first pass only. I became fatigued before finishing.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
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.
ForrestErickson
commented
Jul 25, 2026
These are a significant improvement and therefor Lee wants these changes merged. |
Links
Artifacts (attach if relevant)
Checklist
check for ? in documentation