Skip to content

Improve documentation on writing README files #633

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
carmenbianca wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Improve documentation on writing README files #633

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b073c4f
Add CONTEXT.rst to list of files
carmenbianca Oct 14, 2024
886047f
Fix the order of readme files
carmenbianca Oct 14, 2024
dc9127c
Add documentation for ability to use Markdown
carmenbianca Oct 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions template/module/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,18 @@
Please provide content in the ``readme`` directory:

* **DESCRIPTION.rst** (required)
* **CONTEXT.rst** (optional, highly recommended)
* INSTALL.rst (optional)
* CONFIGURE.rst (optional)
* **USAGE.rst** (optional, highly recommended)
* DEVELOP.rst (optional)
* ROADMAP.rst (optional)
* HISTORY.rst (optional, recommended)
* DEVELOP.rst (optional)
* **CONTRIBUTORS.rst** (optional, highly recommended)
* CREDITS.rst (optional)
* HISTORY.rst (optional, recommended)

Instead of using reStructuredText (``.rst``), you may use Markdown (``.md``) to
format your files.

Content of this README will also be drawn from the addon manifest,
from keys such as name, authors, maintainers, development_status,
Expand Down