Skip to content

Commit

Permalink
Add table of content to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
axdanbol committed Dec 14, 2023
1 parent 57b0f27 commit 5f01ded
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
# hra-workflows-runner
Code to run hra-workflows locally or using Slurm.

## Table of Content
- [Requirements](#requirements)
- [Running the pipeline](#running-the-pipeline)
- [Configuring the environment](#1-configure-the-environment)
- [Running scripts](#2-run-scripts)
- [Running locally](#locally)
- [Using Slurm](#slurm)
- [Adding a new dataset handler](#adding-new-dataset-handlers)
- [Implementing the interfaces](#1-implementing-interfaces)
- [Registering the handler](#2-registering-the-new-handler)

## Requirements
- [cwl-runner](https://github.com/common-workflow-language/cwltool)
- Docker (only when running locally) **OR**
Expand Down

0 comments on commit 5f01ded

Please sign in to comment.