aboutsummaryrefslogtreecommitdiff
path: root/python/python3-setuptools_scm_git_archive/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/python3-setuptools_scm_git_archive/README')
-rw-r--r--python/python3-setuptools_scm_git_archive/README5
1 files changed, 5 insertions, 0 deletions
diff --git a/python/python3-setuptools_scm_git_archive/README b/python/python3-setuptools_scm_git_archive/README
new file mode 100644
index 0000000000..3b39308c01
--- /dev/null
+++ b/python/python3-setuptools_scm_git_archive/README
@@ -0,0 +1,5 @@
+This is a setuptools_scm plugin that adds support for git archives,
+for example the ones GitHub automatically generates.
+
+Note that it only works for archives of tagged commits, because git
+currently lacks a format option equivalent to git describe --tags.