Open
Description
In attempt to help clarify the project readme, I am submitting a proposed amended version of the readme file. The main purposes are:
- Make "maintenance mode" and submission of PRs (pull requests) less ambiguous
- Include License directly in the Readme
- Include "Who it's For" and "Goal" sections
- Update "How to run" and "How to build" sections
I have forked the project, and will make a commit to my fork, and can submit a PR from there if that is appropriate.
I will include a link to a visual diff showing the proposed changes here:
https://github.com/faginr/Proposed-Readme-Changes/blob/main/Visual%20Diff.pdf
Metadata
Metadata
Assignees
Labels
No labels
Activity