diff options
| author | Chloe Kudryavtsev <toast@toastin.space> | 2018-12-20 20:11:45 -0500 |
|---|---|---|
| committer | Chloe Kudryavtsev <toast@toastin.space> | 2018-12-20 20:11:45 -0500 |
| commit | e17fca347b96deb49c98c392f97630ebc3ba7d9b (patch) | |
| tree | e9cc3b55e741ce1501e5c5fa7d5621ebe35c5e6c | |
| parent | 1f1934a59725d7e0fb725080b56be350e8c657ec (diff) | |
| download | user-handbook-e17fca347b96deb49c98c392f97630ebc3ba7d9b.tar.bz2 user-handbook-e17fca347b96deb49c98c392f97630ebc3ba7d9b.tar.xz | |
Add README
| -rw-r--r-- | README.adoc | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..7e41c11 --- /dev/null +++ b/README.adoc @@ -0,0 +1,17 @@ += User Handbook +Chloe Kudryavtsev <toast@toastin.space> + +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). |