Skip to content

Commit a154ff3

Browse files
authored
Update tools.md
1 parent ca62810 commit a154ff3

File tree

1 file changed

+22
-19
lines changed

1 file changed

+22
-19
lines changed

docs/tools.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1+
# *Tool name*
12

2-
# Description
3+
## [*Main repository README*](/README.md)
4+
5+
## Description
36

47
Introduction of tool, including:
58

@@ -10,46 +13,46 @@ Or:
1013

1114
- Link(s) to the available information / documentation
1215

13-
## Link(s)
16+
### Link(s)
1417

15-
## Input(s)
18+
### Input(s)
1619

17-
## Parameter(s)
20+
### Parameter(s)
1821

19-
## Output(s)
22+
### Output(s)
2023

21-
## Container availability & engine
24+
### Container availability & engine
2225

23-
# Diagram
26+
## Diagram
2427

2528
Logical visual description of processing steps for tool, e.g. for pipelines shipped as packages (Falcon, Cellranger, ..)
2629

27-
# Version notes
30+
## Version notes
2831

2932
Any comment on major features being introduced, or default/API changes that might result in unexpected behaviours.
3033

31-
## Containerised version(s)
34+
### Containerised version(s)
3235

3336
Which public registry (Biocontainers, Docker, ..)
3437

3538
Any notes on tagging conventions
3639

37-
# Third party tools / dependencies
40+
## Third party tools / dependencies
3841

39-
# Tutorials
42+
## Tutorials
4043

41-
# Tool infrastructure requirements
44+
## Tool infrastructure requirements
4245

43-
## Scheduler
46+
### Scheduler
4447

45-
## Hardware
48+
### Hardware
4649

47-
# Tool Install
50+
## Tool Install
4851

49-
# *Compute infrastructure name* optimisation (**LINK**)
52+
## *Compute infrastructure name* optimisation (**LINK**)
5053

51-
# Help / FAQ / Troubleshooting
54+
## Help / FAQ / Troubleshooting
5255

53-
# Licence
56+
## Licence
5457

55-
# Acknowledgements / citations / credits
58+
## Acknowledgements / citations / credits

0 commit comments

Comments
 (0)