Repository navigation
Rewrite README for outside readers; add MIT license - #2
Merged
Merged
Conversation
- Rebuild README on Best-README-Template: about, built with, getting started, usage - Add Main and E-Beam tab screenshots (captured with no hardware connected) - Add MIT LICENSE - Document the email_credentials.py setup, including ALERT_SENDER
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
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.
Rebuilds the README for someone who has never seen the project, on the Best-README-Template structure.
requirements.txt.LICENSE(copyright Jacques Attinger, 2025).Merge order: merge #1 first. Both PRs touch the credentials snippet in the README, so this branch needs a quick rebase afterward.
Also adds the project logo (
images/logo.png) at the top of the README.