Skip to content

Commit

Permalink
Update README and add a CONTRIBUTING file
Browse files Browse the repository at this point in the history
  • Loading branch information
milouse committed Jul 19, 2021
1 parent 2b27a7a commit d61670e
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
11 changes: 11 additions & 0 deletions CONTRIBUTING.org
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 6 additions & 1 deletion README.org
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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>
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit d61670e

Please sign in to comment.