diff options
authorChloe Kudryavtsev <toast@toastin.space>2018-12-25 17:37:05 -0500
committerChloe Kudryavtsev <toast@toastin.space>2018-12-25 17:37:05 -0500
commit86b2cbbf094f80b2543ee07b8b8d45aaa71bdeeb (patch)
parent0d8d42ec7b6104f508f5e18f35cc39293f12eb38 (diff)
Translate README Markdown
To make cgit happy
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6e051a1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# User Handbook
+This is the Antora component for the Alpine User Handbook.
+It primarily focuses on to-disk style installations.
+## Deploying
+<!-- TODO: link to playbook repository -->
+You cannot deploy this "on its own" - you will need to either use the Alpine Documentation repository (which contains the antora playbook) to deploy this, or write your own.
+If you want to mirror these docs, please see the instructions in that README.
+## Contributing
+If you want to send a patch, and your name is not yet in the authors list, please add it there.
+Do also note that by contributing the patch, assuming that you have not done so yet, you are agreeing to license your patch (and all future ones) under the license of the repository.
+You will be explicitly asked to confirm that in whatever medium you submit that patch (or you may confirm this in your patch commit message).