-
Notifications
You must be signed in to change notification settings - Fork 70
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #250 from tbirdso/tutorial-metadata
Utility: Add tutorial template and update validator tool
- Loading branch information
Showing
3 changed files
with
84 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# My HoloHub Tutorial | ||
|
||
Provide a splash image highlighting your tutorial. | ||
|
||
## Overview | ||
|
||
Provide a one-sentence summary of your tutorial's purpose and operations. | ||
|
||
## Description | ||
|
||
Provide a detailed summary of your project. Include any necessary background | ||
for the average HoloHub user to understand the general purpose of your project. | ||
Include any diagrams that are helpful for understanding functionality. | ||
|
||
## Data | ||
|
||
Give an overview of any datasets that will be used in your project. | ||
|
||
## Requirements | ||
|
||
List any platform requirements that a user must have before trying to build and run | ||
your project. Requirements could include hardware or software. | ||
|
||
## Tutorial Instructions | ||
|
||
Provide a step-by-step walkthrough of your tutorial and link to any accompanying | ||
tutorial documents. If the tutorial depends on runnable commands, include them | ||
here. | ||
|
||
```bash | ||
<my-command> <my-args> | ||
``` | ||
|
||
## Acknowledgements | ||
|
||
Cite any methods or collaborators here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
{ | ||
"tutorial": { | ||
"name": "My Tutorial", | ||
"description": "Demonstrates how to use Holoscan in a certain fashion.", | ||
"authors": [ | ||
{ | ||
"name": "John Doe", | ||
"affiliation": "My Institution" | ||
} | ||
], | ||
"language": "C++", | ||
"version": "0.1.0", | ||
"changelog": { | ||
"0.1.0": "Initial Release" | ||
}, | ||
"holoscan_sdk": { | ||
"minimum_required_version": "1.0.3", | ||
"tested_versions": [ | ||
"1.0.3" | ||
] | ||
}, | ||
"platforms": [ | ||
"amd64", | ||
"arm64" | ||
], | ||
"tags": [ | ||
"Sensor", | ||
"Processing", | ||
"Tutorial" | ||
], | ||
"ranking": 1, | ||
"dependencies": {} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters