README.md in askclass-course-theme-0.1.0 vs README.md in askclass-course-theme-0.2.0
- old
+ new
@@ -1,19 +1,27 @@
# AskClass News Theme
-[![Build]][Build Link] [![CodeQL]][CodeQL Link]
+[![Deploy Jekyll]][Deploy Jekyll Link] [![Build]][Build Link] [![CodeQL]][CodeQL Link]
Simple responsive Jekyll theme for a course syllabus.
## Installation
+Starting fresh:
```sh
-# If starting fresh add this
$ echo 'source "https://rubygems.org"' > Gemfile
+$ echo 'theme: askclass-course-theme/ > _config.yml
+$ bundle
+$ jekyll serve
+```
+Copy and edit `_config.yml`.
+Copy `index.html`, `pwabuilder-sw.jq`, `404.html`, `_data`, and `content` to the root dir.
+
+Existing project:
+```sh
$ echo 'gem "askclass-course-theme"' >> Gemfile
$ sed -i '1 s/^/theme: askclass-course-theme\n/' _config.yml
-$ bundle
```
----
## Contributing
@@ -43,9 +51,14 @@
[Manifest Categories]: https://developer.mozilla.org/en-US/docs/Web/Manifest/categories
[Google Fonts]: https://fonts.google.com/
[MPL-2.0 License]: https://opensource.org/licenses/MPL-2.0
[Contributor Covenant]: http://contributor-covenant.org
[Card Colors]: https://acn.askclass.com/2022/06/18/card-colors
+
+[Deploy Jekyll]: https://github.com/beAuthentic/askclass-course-theme/actions/workflows/pages.yml/badge.svg
+[Deploy Jekyll Link]: https://github.com/beAuthentic/askclass-course-theme/actions/workflows/pages.yml
+
[Build]: https://github.com/beAuthentic/askclass-course-theme/actions/workflows/gem-push.yml/badge.svg
[Build Link]: https://github.com/beAuthentic/askclass-course-theme/actions/workflows/gem-push.yml
+
[CodeQL]: https://github.com/beAuthentic/askclass-course-theme/actions/workflows/codeql-analysis.yml/badge.svg
[CodeQL Link]: https://github.com/beAuthentic/askclass-course-theme/actions/workflows/codeql-analysis.yml