Skip to content

Commit ce8c6b5

Browse files
committed
1 parent e05d305 commit ce8c6b5

File tree

2 files changed

+39
-3
lines changed

2 files changed

+39
-3
lines changed

CITATION.cff

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
cff-version: 0.0.1
2+
message: "If you use these documentation guidelines, please cite as below."
3+
authors:
4+
- family-names: Gustafsson
5+
given-names: Johan
6+
orcid: https://orcid.org/0000-0002-2977-5032
7+
- family-names: Davis
8+
given-names: Brian
9+
orcid:
10+
- family-names: de la Pierre
11+
given-names: Marco
12+
orcid: https://orcid.org/0000-0002-7429-1846
13+
- family-names: Stott
14+
given-names: Audrey
15+
orcid:
16+
- family-names: Beecroft
17+
given-names: Sarah
18+
orcid: https://orcid.org/0000-0002-3935-2279
19+
- family-names: Downton
20+
given-names: Matthew
21+
orcid:
22+
- family-names: Edwards
23+
given-names: Richard
24+
orcid: https://orcid.org/0000-0002-3645-5539
25+
- family-names: Chew
26+
given-names: Tracy
27+
orcid: https://orcid.org/0000-0001-9529-7705
28+
- family-names: Samaha
29+
given-names: Georgina
30+
orcid: https://orcid.org/0000-0003-0419-1476
31+
title: "Australian BioCommons Documentation Guidelines"
32+
version: 1.3.0
33+
doi:
34+
date-released: 2021-10-29

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@
55
> You can make use of this template repository as a base template for a new GitHub repository.
66
>
77
> **General information about the guidelines**
8-
>- This **template** repository contains a set of guidelines for documenting bioinformatics tools and workflows.
9-
>- The initial version uploaded to GitHub was informed by current documentation practices and structures used in the GitHub community.
10-
>- These guidelines will be further developed as needed to meet the requirements of the Australian BioCommons community.
8+
- This **template** repository contains a set of guidelines for documenting bioinformatics tools and workflows.
9+
- There is a How-to-Guide to using this repository available here: https://australianbiocommons.github.io/how-to-guides/documentation/DocumentationGuidelines
10+
- The initial version uploaded to GitHub was informed by current documentation practices and structures used in the GitHub community.
11+
- Typical files are included, such as a `LICENSE`, `CITATION.cff` and `change_log.md`
12+
- These guidelines will be further developed as needed to meet the requirements of the Australian BioCommons community.
1113

1214
---
1315

0 commit comments

Comments
 (0)