add python-package-template command to readme

craigahobbs · Aug 17, 2021 · b78afeb · b78afeb
1 parent aebe77c
commit b78afeb
Show file tree

Hide file tree

Showing 6 changed files with 62 additions and 6 deletions.
diff --git a/template/README.md b/template/README.md
@@ -10,4 +10,15 @@ Coming soon!
 
 ## Development
 
-This project is developed using [Python Build](https://github.com/craigahobbs/python-build#readme).
+This project is developed using [Python Build](https://github.com/craigahobbs/python-build#readme). It was started
+using [python-package-template](https://github.com/craigahobbs/python-package-template#readme) as follows:
+
+```
+template-specialize python-package-template/template/ {{package}}/ \
+    -k package {{package}} \
+    -k name "{{name}}" \
+    -k email "{{email}}" \
+    -k github "{{github}}" \{% if nodoc is defined and nodoc %}
+    -k nodoc 1{% endif %}{% if nomain is defined and nomain %}
+    -k nomain 1{% endif %}
+```
diff --git a/template/README.rst b/template/README.rst
@@ -33,4 +33,13 @@ Links
 Development
 -----------
 
-This project is developed using `Python Build <https://github.com/craigahobbs/python-build#readme>`__.
+This project is developed using `Python Build <https://github.com/craigahobbs/python-build#readme>`__. It was started
+using `python-package-template <https://github.com/craigahobbs/python-package-template#readme>`__ as follows::
+
+    template-specialize python-package-template/template/ {{package}}/ \
+        -k package {{package}} \
+        -k name "{{name}}" \
+        -k email "{{email}}" \
+        -k github "{{github}}" \{% if nodoc is defined and nodoc %}
+        -k nodoc 1{% endif %}{% if nomain is defined and nomain %}
+        -k nomain 1{% endif %}
diff --git a/test_expected/test_nodoc/README.md b/test_expected/test_nodoc/README.md
@@ -10,4 +10,14 @@ Coming soon!
 
 ## Development
 
-This project is developed using [Python Build](https://github.com/craigahobbs/python-build#readme).
+This project is developed using [Python Build](https://github.com/craigahobbs/python-build#readme). It was started
+using [python-package-template](https://github.com/craigahobbs/python-package-template#readme) as follows:
+
+```
+template-specialize python-package-template/template/ package-name/ \
+    -k package package-name \
+    -k name "John Doe" \
+    -k email "[email protected]" \
+    -k github "johndoe" \
+    -k nodoc 1
+```
diff --git a/test_expected/test_nodoc_nomain/README.md b/test_expected/test_nodoc_nomain/README.md
@@ -10,4 +10,15 @@ Coming soon!
 
 ## Development
 
-This project is developed using [Python Build](https://github.com/craigahobbs/python-build#readme).
+This project is developed using [Python Build](https://github.com/craigahobbs/python-build#readme). It was started
+using [python-package-template](https://github.com/craigahobbs/python-package-template#readme) as follows:
+
+```
+template-specialize python-package-template/template/ package-name/ \
+    -k package package-name \
+    -k name "John Doe" \
+    -k email "[email protected]" \
+    -k github "johndoe" \
+    -k nodoc 1
+    -k nomain 1
+```
diff --git a/test_expected/test_nomain/README.rst b/test_expected/test_nomain/README.rst
@@ -33,4 +33,12 @@ Links
 Development
 -----------
 
-This project is developed using `Python Build <https://github.com/craigahobbs/python-build#readme>`__.
+This project is developed using `Python Build <https://github.com/craigahobbs/python-build#readme>`__. It was started
+using `python-package-template <https://github.com/craigahobbs/python-package-template#readme>`__ as follows::
+
+    template-specialize python-package-template/template/ package-name/ \
+        -k package package-name \
+        -k name "John Doe" \
+        -k email "[email protected]" \
+        -k github "johndoe" \
+        -k nomain 1
diff --git a/test_expected/test_required/README.rst b/test_expected/test_required/README.rst
@@ -33,4 +33,11 @@ Links
 Development
 -----------
 
-This project is developed using `Python Build <https://github.com/craigahobbs/python-build#readme>`__.
+This project is developed using `Python Build <https://github.com/craigahobbs/python-build#readme>`__. It was started
+using `python-package-template <https://github.com/craigahobbs/python-package-template#readme>`__ as follows::
+
+    template-specialize python-package-template/template/ package-name/ \
+        -k package package-name \
+        -k name "John Doe" \
+        -k email "[email protected]" \
+        -k github "johndoe" \