Skip to content

Improve README.md documentation#46

Merged
AntonioCS merged 1 commit intomainfrom
chore/improve-readme-documentation
Jan 5, 2026
Merged

Improve README.md documentation#46
AntonioCS merged 1 commit intomainfrom
chore/improve-readme-documentation

Conversation

@AntonioCS
Copy link
Owner

Summary

  • Comprehensive overhaul of README.md documentation
  • Remove Windows support, recommend WSL instead
  • Add new sections: Common Commands, Module System, Project Structure, Debug Options, Available Modules
  • Streamline existing Installation and Upgrading Make sections
  • Create modules/README.md with detailed module creation guide
  • Create core/README.md with core system documentation
  • Update CLAUDE.md with README maintenance notes

New Files

  • modules/README.md - Module structure, creation guide, best practices
  • core/README.md - Core functions, utilities, loading order

Trello

Closes https://trello.com/c/IzswNewA

- Remove Windows support, recommend WSL instead
- Add Common Commands section with table
- Add Module System section with link to modules/README.md
- Add Project Structure section with bind-hub layout
- Add Debug Options section
- Add Available Modules section
- Streamline Installation and Upgrading Make sections
- Create modules/README.md with detailed module creation guide
- Create core/README.md with core system documentation
- Update CLAUDE.md with README maintenance notes
@AntonioCS AntonioCS merged commit d803783 into main Jan 5, 2026
1 check passed
@AntonioCS AntonioCS deleted the chore/improve-readme-documentation branch January 5, 2026 20:44
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.

1 participant