Skip to content

Documentation & Environment configuration updates#123

Open
MysticalMike60t wants to merge 30 commits into
TomBadash:masterfrom
MysticalMike60t:master
Open

Documentation & Environment configuration updates#123
MysticalMike60t wants to merge 30 commits into
TomBadash:masterfrom
MysticalMike60t:master

Conversation

@MysticalMike60t
Copy link
Copy Markdown

@MysticalMike60t MysticalMike60t commented Apr 22, 2026

Summary of Changes

  • Re-wrote README.md and README_CN.md files to look nice and clean (they looked AI generated before).
  • Added branding assets used in the README files to .github folder.
  • Moved Contributing stuff to .github/CONTRIBUTING.md.
  • Moved other Markdown documentation files to the .github folder.
  • Created .github/CHANGELOG.md file to track major changes (not needed, but recommended).
  • Created .python-version file to specify specific python version to use for development.
  • Made small tweaks to Mouser.bat for redundancy.
  • Created basic pyproject.toml to handle development and production builds (not fully tested, only simple testing), plus installations via python -m pip install --editable ..

@thisislvca
Copy link
Copy Markdown
Collaborator

Hey @MysticalMike60t, thanks a ton for this! I'm actually already working on a docs rewrite, but this is awesome. I'll keep you posted, hoping we can get around to this soon :)

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