diff options
| author | Chloe Kudryavtsev <toast@toastin.space> | 2019-05-26 12:54:29 -0400 |
|---|---|---|
| committer | Chloe Kudryavtsev <toast@toastin.space> | 2019-05-26 12:54:29 -0400 |
| commit | cc7d7ca0fd0a080139bd05c674b7a8643d639ee3 (patch) | |
| tree | 56de858a95f873f1a08d19b86acef8f8f0845b67 /README.md | |
| download | developer-handbook-master.tar.bz2 developer-handbook-master.tar.xz | |
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..1e78e3e --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# Developer Handbook + +This is the Antora component for the Alpine Developer Handbook. +It contains various pertinent information regarding the Alpine Linux project and various relevant information intended for developers and contributors. + +## Deploying + +You cannot display this "on its own" - you will need to either see the instructions in the [playbook repostory](https://git.alpinelinux.org/docs/docs.a.o/) or write your own Antora playbook. + +## 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). |