Skip to content

Commit

Permalink
Add definition for README
Browse files Browse the repository at this point in the history
  • Loading branch information
pengqun committed Mar 5, 2024
1 parent 1fb8cd8 commit 35f8ac7
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,8 @@ Assist users in understanding and navigating the features and functionalities of

#### README

README files are a staple of any code project. They provide the first introduction to a new codebase and help you share important project details with collaborators.

- [Best-README-Template](https://github.com/othneildrew/Best-README-Template) - An awesome README template to jumpstart your projects.
- [Awesome README](https://github.com/matiassingers/awesome-readme) - A curated list of awesome READMEs, including examples, articles and tools.
- [README template](https://gitlab.com/tgdp/templates/-/blob/main/readme/template-readme.md) - Open-source template provided by The Good Docs Project.
Expand Down

0 comments on commit 35f8ac7

Please sign in to comment.