~torresjrjr/hare-mayan

d4a9c396047b88f9054a811272b0e7bebd027cfb — Byron Torres 1 year, 11 months ago 021d2ce
add README.md
1 files changed, 59 insertions(+), 0 deletions(-)

M README.md
M README.md => README.md +59 -0
@@ 1,2 1,61 @@
hare-mayan
==========

This Hare package provides the "Mayan" chronology, based upon the
Mesoamerican Long Count calendar system.

Status: pre-alpha


Provided modules
----------------

- **time::mayan**: Provides the "Mayan" chronology.


Installation
------------

### From your distribution

This recommended name for this package is "hare-mayan".
Look for this, or something similar, in your local package manager.
This is the preferred way to install this package.

### System-wide installation

```
make install
```

### Vendoring

```
git subtree -P vendor/hare-mayan/ \
	add https://git.sr.ht/~torresjrjr/hare-mayan master
```


Contributing
------------

All contributors are required to "sign-off" their commits to indicate
that they have agreed to the [Developer Certificate of Origin][dco].
Use `git commit -s` or `git config format.signoff true`.

Send patches to <~torresjrjr/public-inbox@lists.sr.ht>
[[archive]][arch].


Licensing
---------

Like the Hare standard library, this library is available under the
terms of the Mozilla Public License (MPL). You can freely link to the
library with software distributed under any license, but if you modify
the library, you must release your derivative works under the MPL as
well.


[dco]: https://developercertificate.org/
[arch]: https://lists.sr.ht/~torresjrjr/public-inbox