Skip to content
This repository has been archived by the owner on May 29, 2023. It is now read-only.

Format README #2

Open
DanielFL0 opened this issue Oct 20, 2020 · 0 comments
Open

Format README #2

DanielFL0 opened this issue Oct 20, 2020 · 0 comments
Assignees
@DanielFL0
Labels
documentation Improvements or additions to documentation

Comments

@DanielFL0
Copy link
Member

READMEs generally follow one format in order to immediately orient developers to the most important aspects of your project. READMEs generally use the following pattern:

  • Project name
  • Description
  • Table of Contents
  • Installation
  • Usage
  • Contributing
  • Credits
  • License

I suggest we consider using this pattern for this project's documentation.
@DanielFL0 DanielFL0 added the documentation Improvements or additions to documentation label Oct 20, 2020
@DanielFL0 DanielFL0 self-assigned this Oct 31, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@DanielFL0 DanielFL0

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@DanielFL0