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.

Sign up for GitHub

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

Jump to bottom

Proposed Readme Amendments #755

Open

faginr opened this issue Jun 6, 2022 · 0 comments

faginr commented Jun 6, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment