Skip to content

armgit / wger

Public Imported from GitHub
0

Self hosted FLOSS fitness/workout, nutrition and weight tracker

Add a simple readme file to the author generation script

Roland Geiderf1862bdb1497
diff --git a/extras/authors/README.md b/extras/authors/README.md
new file mode 100644
index 000000000..789f76615
--- /dev/null
+++ b/extras/authors/README.md
@@ -0,0 +1,13 @@
+# Generate authors list
+
+This small script reads the commit information and generates a list of authors
+and links them to their Github profile, if available. This can be run before
+each release to keep the data up to date.
+
+## Usage
+
+Generate a token to avoid the rate limiting on the Github API:
+<https://github.com/settings/personal-access-tokens> (no need to select any
+permissions, we're just performing reading operations on public data)
+
+Run the script and optionally copy the generated files to their correct locations