✨ Initial commit of README.md template

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Franklin Koch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,7 @@
+# readme-md MyST Template
+
+![](thumbnail.png)
+
+This template creates a very basic `README.md` file with title, author names, and abstract.
+
+In the future, there is tons of room to expand. It might be nice to add options for badges and maybe the ability to bring in other content besides abstract.

template.md

@@ -0,0 +1,9 @@
+# [-doc.title-]
+
+[# for author in doc.authors #]
+[# if loop.first #]## [# endif #][-author.name-][# if not loop.last #], [# else #]
+
+
+[# endif #]
+[# endfor #]
+[- parts.abstract -]

template.yml

@@ -0,0 +1,30 @@
+jtex: v1
+kind: md
+title: Template for basic README.md
+description: Easily create a readme from existing MyST content
+template: template.md
+files:
+  - template.md
+  - LICENSE
+authors:
+  - name: Franklin Koch
+    github: fwkoch
+    affiliations:
+      - Curvenote
+version: 0.0.1
+license: MIT
+tags:
+  - readme
+thumbnail: ./screenshot.png
+github: https://github.com/myst-templates/readme-md
+doc:
+  - id: title
+    required: true
+  - id: authors
+parts:
+  - id: abstract
+    description: >
+      An abstract is a short summary of your research paper or report. A good
+      abstract will prepare readers for the detailed information to follow,
+      communicate the essence of the article and help readers take away and remember key points.
+    required: true