aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorGravatar √Čtienne Deparis 2021-07-19 19:37:14 +0200
committerGravatar √Čtienne Deparis 2021-07-19 19:37:14 +0200
commitd61670e2b79944566417588c3ce1197d0a744d3e (patch)
tree2cfb420ac09fc8d361d8d5b2b3fc965099b1a5e3
parent2b27a7ab961933595d7f21afe3eaa2b00962eb49 (diff)
downloadlatex-awesomebox-d61670e2b79944566417588c3ce1197d0a744d3e.tar.gz
latex-awesomebox-d61670e2b79944566417588c3ce1197d0a744d3e.tar.xz
latex-awesomebox-d61670e2b79944566417588c3ce1197d0a744d3e.zip
Update README and add a CONTRIBUTING fileHEADmain
-rw-r--r--CONTRIBUTING.org11
-rw-r--r--README.org7
2 files changed, 17 insertions, 1 deletions
diff --git a/CONTRIBUTING.org b/CONTRIBUTING.org
new file mode 100644
index 0000000..e656bf6
--- /dev/null
+++ b/CONTRIBUTING.org
@@ -0,0 +1,11 @@
+#+title: CONTRIBUTING
+#+options: toc:nil
+#+language: en
+
+The canonical repository is located at
+[[https://git.umaneti.net/latex-awesomebox]]. Before submitting a patch, please
+ensure first you are correctly rebased on the last status of the ~main~ branch
+there.
+
+To ease contribution, a mirror also exists on [[https://github.com/gutenberg/latex-awesomebox][Github]], where merge requests and
+issues are welcomed too.
diff --git a/README.org b/README.org
index 3396f2f..6b64c25 100644
--- a/README.org
+++ b/README.org
@@ -1,5 +1,6 @@
#+title: Awesome Boxes
#+options: toc:nil
+#+language: en
Awesome Boxes is all about drawing admonition blocks around text to
inform or alert your readers about something particular. The specific
@@ -9,7 +10,7 @@ illustration of these blocks.
The idea of admonition blocks comes from the ones you can easily do with
[[https://docs.asciidoctor.org/asciidoc/latest/blocks/admonitions/][AsciiDoc]].
-For more details, please refer to the [[https://github.com/milouse/latex-awesomebox/blob/master/awesomebox.pdf][awesomebox.pdf]] document.
+For more details, please refer to the [[https://git.umaneti.net/latex-awesomebox/plain/awesomebox.pdf][awesomebox.pdf]] document.
#+html: <a href="https://liberapay.com/milouse/donate"><img alt="Support using Liberapay" src="https://img.shields.io/badge/Liberapay-Support_me-yellow?logo=liberapay"/></a>
#+html: <a href="https://paypal.me/milouse"><img alt="Support using Paypal" src="https://img.shields.io/badge/Paypal-Support_me-00457C?logo=paypal&labelColor=lightgray"/></a>
@@ -54,6 +55,10 @@ and thus using the compatibility package may break your current
files. FontAwesome also requires you to use XeLaTeX or LuaTeX: you
cannot use PDFLaTeX with the compatibility package.
+* Contribution
+
+See [[./CONTRIBUTING.org][CONTRIBUTING file]].
+
* License
Awesome Box is released under the [[http://www.wtfpl.net/txt/copying/][WTFPL]]. A copy of this license is