Skip to content

Commit 4584f57

Browse files
author
Bhavesh Patel
authored
Update README.md
1 parent b85f964 commit 4584f57

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

main/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@
1818

1919
## 3. Document software
2020

21-
3.1. Maintain the documentation in a file called "README" using plain text or markdown syntax. Locate it in the root directory of the software. Mature/complex software may require additional, more sophisticated documentation that can be developed e.g. using tools such as [GitHub pages](https://pages.github.com/), [Read the Docs](https://readthedocs.org/), or [Docusaurus](https://docusaurus.io/). The following aspects must be documented as applicable
21+
3.1. Maintain the documentation in a file called "README" using plain text or markdown syntax. Locate it in the root directory of the software. Mature/complex software may require additional, more sophisticated documentation that can be developed e.g. using tools such as [GitHub pages](https://pages.github.com/) or [Read the Docs](https://readthedocs.org/). The following aspects must be documented as applicable
2222
- Overall description of the software (e.g., in an “About” section)
2323
- High-level dependencies of the software (e.g., Node or Python version)
2424
- Inputs and outputs of the software, parameters and data required to run the software
2525
- The standards followed
2626
- How to contribute to the software
2727
- How to cite the software
2828

29-
In addition, follow any community agreed standard documentation approach when available (e.g., the [Common Workflow Language (CWL)](https://www.commonwl.org/) for describing command line tools).
29+
In addition, follow any community-agreed standard documentation approach when available (e.g., the [Common Workflow Language (CWL)](https://www.commonwl.org/) for describing command line tools).
3030

3131
3.2. Document changes between different versions of the software in a file called “CHANGELOG” using plain text or markdown syntax. Locate it in the root directory of the software. We suggest following the “[Keep a changelog](https://keepachangelog.com/)” conventions for the content of the CHANGELOG file and the [Semantic Versioning v2.0.0](https://semver.org/spec/v2.0.0.html) for version numbers.
3232

0 commit comments

Comments
 (0)