Skip to content

Commit

Permalink
Updated odtp-component-client and README template
Browse files Browse the repository at this point in the history
  • Loading branch information
caviri committed Apr 18, 2024
1 parent c473229 commit 449a116
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 1 deletion.
62 changes: 62 additions & 0 deletions README.template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Name of the component

Description of the component

| Tool Info | Links |
| --- | --- |
| Original Tool | []() |
| Current Tool Version | [commit-hash](link-to-commit-hash) |


## ODTP command

```
odtp new odtp-component-entry \
--name odtp-component \
--component-version x.y.z \
--repository Link to repository
```

## Data sheet

### Parameters

| Parameter | Description | Default Value |
| --- | --- | --- |
| A | B | C |

### Input Files

| File/Folder | Description |
| --- | --- |
| A | B |

### Output Files

| File/Folder | Description |
| --- | --- |
| A | B |

## Tutorial

### How to run this component as docker

Build the dockerfile

```
docker build -t odtp-component .
```

Run the following command. Mount the correct volumes for input/output folders.

```
docker run -it --rm \
-v {PATH_TO_YOUR_INPUT_VOLUME}:/odtp/odtp-input \
-v {PATH_TO_YOUR_OUTPUT_VOLUME}:/odtp/odtp-output \
--env-file .env odtp-component
```


## Developed by

XXXXXXXXXX
2 changes: 1 addition & 1 deletion odtp-component-client

0 comments on commit 449a116

Please sign in to comment.