From 08d84591f8da0a9d2b25f70f42a8f8e334d0aa28 Mon Sep 17 00:00:00 2001 From: Katherine Cox Date: Wed, 9 Aug 2023 15:37:20 -0400 Subject: [PATCH] add README template for courses --- .github/course_README_template.md | 24 +++++++++++++++++++++ .github/workflows/starting-course.yml | 1 + README.md | 30 --------------------------- 3 files changed, 25 insertions(+), 30 deletions(-) create mode 100644 .github/course_README_template.md diff --git a/.github/course_README_template.md b/.github/course_README_template.md new file mode 100644 index 00000000..1c9ccdf7 --- /dev/null +++ b/.github/course_README_template.md @@ -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}. + +Creative Commons License
All materials in this course are licensed under a Creative Commons Attribution 4.0 International License unless noted otherwise. diff --git a/.github/workflows/starting-course.yml b/.github/workflows/starting-course.yml index d1683f28..5ded0b20 100644 --- a/.github/workflows/starting-course.yml +++ b/.github/workflows/starting-course.yml @@ -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 \ diff --git a/README.md b/README.md index 743969f3..04db84a6 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ - - ## Open-source Tools for Training Resources - OTTR Go to [ottrproject.org](https://www.ottrproject.org/) to get started! :tada: @@ -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. - - -# {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}. - -Creative Commons License
All materials in this course are licensed under a Creative Commons Attribution 4.0 International License unless noted otherwise.