Skip to content

Rewrite the README to be more clear and concise #401

Description

@4ns0n

Checklist

  • I made sure that there are no existing issues - open or closed - to which I could contribute my information.
  • I made sure that there are no existing discussions - open or closed - to which I could contribute my information.
  • I have read the FAQs inside the app (Menu -> About -> FAQs) and my problem isn't listed.
  • I have taken the time to fill in all the required details. I understand that the request will be dismissed otherwise.
  • This issue contains only one feature request.
  • I have read and understood the contribution guidelines.

Feature description

The current README is very wordy and poorly organized, and is somewhat unclear about certain features, so I think it would be helpful to rewrite it.

Why do you want this feature?

I think it can help make the features of the app clearer for people installing it.

Additional information

I wasn't sure what the best way to contribute this was, so I put my suggested revisions in a pull request. Apologies if this was a better way to contribute this that I should've done.

Metadata

Metadata

Assignees

No one assigned

    Labels

    feature requestIssue is about a new feature or improving existing feature/behavior.needs triageIssue is not yet ready for PR authors to take up

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions