Skip to content

TODO: Break README into multiple docs #11

@cyrusae

Description

@cyrusae

Low-priority but might be nice: break out the README so that the skeleton "what is this, how do you use it, and why" is more focused with more details in subsidiary files.

TODO: Which details get broken out?

  • the more detailed "what command to use where" ones?
  • examples section -> "see examples/README.md"?
  • philosophy section?

The problem with the README containing everything I want it to is now I feel like it might be too beefy... but it literally has all the contents I wanted...

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions