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

Overhaul readme and add new instructions #55

Open
wants to merge 33 commits into
base: main
Choose a base branch
from
Open

Overhaul readme and add new instructions #55

wants to merge 33 commits into from

Conversation

queengooborg
Copy link
Collaborator

@queengooborg queengooborg commented Dec 1, 2024

This PR performs a number of updates to the readme to improve the documentation, including separating large sections into their own documents. This provides the benefit of consolidating the readme without losing any details.

In particular, this PR performs the following:

  • General Cleanup
    • Format Readme using Prettier
    • Bambulab -> Bambu Lab
    • "github" -> "GitHub"
    • Convert date format to international format
  • Rearrangements
    • Rearrange sections for better flow
    • Move details of Bambu Lab RFID tag blocks to its own document
    • Move key derivation script to its own file
    • Move legacy sniffing instructions to its own document to de-clutter the Readme
  • New Info
    • Re-add link to Discord
    • Require the Iceman fork of pm3
    • An AMS is no longer required equipment
    • Add Creality RFID tag format info
    • Add instructions on how to use key derivation to obtain tag data
    • Add instructions for Flipper Zero usage
  • Updated Sections
    • Simplify instructions for using recovery script
    • Simplify RFID board reverse-engineering section
    • Update "How to contribute"

@queengooborg queengooborg changed the title Overhaul readme Overhaul readme and add new instructions Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants