Move README template into .github/.

realazthat · Aug 7, 2024 · 6ffb9ab · 6ffb9ab
1 parent 8a228c8
commit 6ffb9ab
Show file tree

Hide file tree

Showing 8 changed files with 206 additions and 10 deletions.
diff --git a/.github/README.help.generated.svg b/.github/README.help.generated.svg
diff --git a/README.md.jinja2 → .github/README.md.jinja2 b/README.md.jinja2 → .github/README.md.jinja2
diff --git a/.github/README.remotified.md b/.github/README.remotified.md
@@ -1,7 +1,7 @@
 <!--
 
 WARNING: This file is auto-generated by snipinator. Do not edit directly.
-SOURCE: `README.md.jinja2`.
+SOURCE: `.github/README.md.jinja2`.
 
 -->
 <!--
@@ -181,13 +181,13 @@ $ python -m mdreftidy.cli ./mdreftidy/examples/SIMPLE.md --move-to-bottom --remo
 All together now:
 
 <!---->
-<img alt="Output of `bash ./snipinator/examples/simple_example.sh`" src="https://raw.githubusercontent.com/realazthat/mdreftidy/v0.6.0/README.simple-output.generated.svg"/>
+<img alt="Output of `bash ./snipinator/examples/simple_example.sh`" src="https://raw.githubusercontent.com/realazthat/mdreftidy/v0.6.0/.github/README.simple-output.generated.svg"/>
 <!-- -->
 
 ## 💻 Command Line Options
 
 <!---->
-<img alt="Output of `python -m mdreftidy.cli --help`" src="https://raw.githubusercontent.com/realazthat/mdreftidy/v0.6.0/README.help.generated.svg"/>
+<img alt="Output of `python -m mdreftidy.cli --help`" src="https://raw.githubusercontent.com/realazthat/mdreftidy/v0.6.0/.github/README.help.generated.svg"/>
 <!-- -->
 
 ## 💡 Examples

diff --git a/README.simple-output.generated.svg → .github/README.simple-output.generated.svg b/README.simple-output.generated.svg → .github/README.simple-output.generated.svg
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 <!--
 
 WARNING: This file is auto-generated by snipinator. Do not edit directly.
-SOURCE: `README.md.jinja2`.
+SOURCE: `.github/README.md.jinja2`.
 
 -->
 <!--
@@ -181,13 +181,13 @@ $ python -m mdreftidy.cli ./mdreftidy/examples/SIMPLE.md --move-to-bottom --remo
 All together now:
 
 <!---->
-<img src="README.simple-output.generated.svg" alt="Output of `bash ./snipinator/examples/simple_example.sh`" />
+<img src=".github/README.simple-output.generated.svg" alt="Output of `bash ./snipinator/examples/simple_example.sh`" />
 <!---->
 
 ## 💻 Command Line Options
 
 <!---->
-<img src="README.help.generated.svg" alt="Output of `python -m mdreftidy.cli --help`" />
+<img src=".github/README.help.generated.svg" alt="Output of `python -m mdreftidy.cli --help`" />
 <!---->
 
 ## 💡 Examples

diff --git a/pyproject.toml b/pyproject.toml
@@ -116,7 +116,7 @@ dev = [
   "rich-argparse==1.4.0",
   "secretstorage==3.3.3",
   "semver==3.0.2",
-  "snipinator==2.2.0",
+  "snipinator==3.1.1",
   "soupsieve==2.5",
   "toml-sort==0.23.1",
   "tomli==2.0.1",

diff --git a/scripts/format.sh b/scripts/format.sh
@@ -19,9 +19,9 @@ find ./mdreftidy/examples -type f -name "*.md" ! -path '*.tidied.md' -print0 | w
   bash scripts/utilities/prettier.sh --parser markdown "${MARKDOWN_TEMPLATE}" --write
 done
 
-python -m mdreftidy.cli "${PWD}/README.md.jinja2" \
+python -m mdreftidy.cli "${PWD}/.github/README.md.jinja2" \
   --renumber --remove-unused --move-to-bottom --sort-ref-blocks --inplace
-bash scripts/utilities/prettier.sh --parser markdown "${PWD}/README.md.jinja2" --write
+bash scripts/utilities/prettier.sh --parser markdown "${PWD}/.github/README.md.jinja2" --write
 bash scripts/utilities/prettier.sh --parser markdown "${PWD}/LICENSE.md" --write
 
 python -m yapf -r ./mdreftidy -i

diff --git a/scripts/generate-readme.sh b/scripts/generate-readme.sh
@@ -41,7 +41,7 @@ echo "${TMP_DIR}/simple_example.output" \
   > "${TMP_DIR}/snipinator-args.json"
 
 python -m snipinator.cli \
-  -t "${PROJ_PATH}/README.md.jinja2" \
+  -t "${PROJ_PATH}/.github/README.md.jinja2" \
   --args "$(cat "${TMP_DIR}/snipinator-args.json")" \
   --rm \
   --force \