Skip to content

Proposed Readme Amendments #755

Open
@faginr

Description

@faginr

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

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions