Skip to content

Commit

Permalink
add README template for courses
Browse files Browse the repository at this point in the history
  • Loading branch information
KatherineCox committed Aug 9, 2023
1 parent 10e42fd commit 08d8459
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 30 deletions.
24 changes: 24 additions & 0 deletions .github/course_README_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# {Course Name}

This course was created from [this GitHub template](https://github.com/jhudsl/OTTR_Template).

You can see the rendered course material here: {Link to rendered bookdown and/or to the Leanpub.}

If you would like to contribute to this course material, take a look at the [OTTR documentation](https://www.ottrproject.org/).

## About this course

This course introduces {info on what this course introduces}

## Learning Objectives

This course will teach learners to:

- {You can use https://www.bobpikegroup.com/trainer-blog/5-steps-to-writing-clear-and-measurable-learning-objectives to define some learning objectives here}
- {More learning objectives}

## Encountering problems?

If you are encountering any problems with this course, please file a GitHub issue or contact us at {Some email or web address with a contact form}.

<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />All materials in this course are licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a> unless noted otherwise.
1 change: 1 addition & 0 deletions .github/workflows/starting-course.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ jobs:
- name: Cleanup
run: |
# Cleanup
mv .github/course_README_template.md README.md
rm -rf \
.github/workflows/report-maker.yml \
.github/workflows/send-updates.yml \
Expand Down
30 changes: 0 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
<!--Delete this section below upon using the template-->

## Open-source Tools for Training Resources - OTTR

Go to [ottrproject.org](https://www.ottrproject.org/) to get started! :tada:
Expand Down Expand Up @@ -33,31 +31,3 @@ _This template and guide helps you_:
- Please take a look at the [code of conduct](./code_of_conduct.md).
- If you encounter any problems or have ideas for improvements to this template repository or this getting started guide, please [file an issue here](https://github.com/jhudsl/OTTR_Template/issues/new/choose)! Your feedback is very much appreciated.

<!--Delete everything above this line upon using the template-->

# {Course Name}

[![Render Bookdown and Coursera](https://github.com/jhudsl/OTTR_Template/actions/workflows/render-all.yml/badge.svg)](https://github.com/jhudsl/OTTR_Template/actions/workflows/render-all.yml)

This course was created from [this GitHub template](https://github.com/jhudsl/OTTR_Template).

You can see the rendered course material here: {Link to rendered bookdown and/or to the Leanpub.}

If you would like to contribute to this course material, take a look at the [getting started GitHub wiki pages](https://github.com/jhudsl/OTTR_Template/wiki).

## About this course

This course introduces {info on what this course introduces}

## Learning Objectives

This course will teach learners to:

- {You can use https://www.bobpikegroup.com/trainer-blog/5-steps-to-writing-clear-and-measurable-learning-objectives to define some learning objectives here}
- {More learning objectives}

## Encountering problems?

If you are encountering any problems with this course, please file a GitHub issue or contact us at {Some email or web address with a contact form}.

<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />All materials in this course are licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a> unless noted otherwise.

0 comments on commit 08d8459

Please sign in to comment.