Skip to content

Commit

Permalink
docs: rephrase docs folder for readme
Browse files Browse the repository at this point in the history
  • Loading branch information
FaGru3n committed Dec 18, 2023
1 parent de0ab53 commit cde0086
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/release/trg-1/trg-1-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Each repository **must** contain a `README.md` file which **shall** cover follow
Best practices:

- If installation instructions for your product are too complex being part of `README.md` move its content to a separate `INSTALL.md` file, see [TRG 1.02](trg-1-2.md).
- If your project is too complex to be described in a single `README.md` file, consider creating a `docs` folder and link your `README.md` to it.
- If your project is too complex to be described in a single `README.md` file, it may be beneficial to relocate specific sections to a dedicated `docs/` folder.
- If your project has multiple component repositories (e.g. frontend and backend), link the other repositories in your leading repository in your `README.md` mutually.

In summary, a good README is a crucial component of any repository, serving as a gateway for users and contributors to understand, use, and potentially contribute to your project. It's a fundamental part of effective project communication and collaboration.
Expand Down

0 comments on commit cde0086

Please sign in to comment.