mirror of
https://github.com/spiral-project/ihatemoney.git
synced 2025-04-28 17:32:38 +02:00
Convert rst readme to markdown
This commit is contained in:
parent
33e2e7b5c2
commit
dc25f8dbe4
2 changed files with 45 additions and 49 deletions
45
README.md
Normal file
45
README.md
Normal file
|
@ -0,0 +1,45 @@
|
||||||
|
# I hate money
|
||||||
|
|
||||||
|
[![GitHub Actions Status][]][1] [![Translation status from Weblate][]][2] [![Donate][]][3]
|
||||||
|
|
||||||
|
*I hate money* is a web application made to ease shared budget
|
||||||
|
management. It keeps track of who bought what, when, and for whom; and
|
||||||
|
helps to settle the bills.
|
||||||
|
|
||||||
|
- [Online documentation][]
|
||||||
|
- [Hosted version][]
|
||||||
|
- [Mailing list][] (to get updates when needed).
|
||||||
|
|
||||||
|
The code is distributed under a BSD *beerware* derivative: if you meet
|
||||||
|
the people in person and you want to pay them a craft beer, you are
|
||||||
|
highly encouraged to do so.
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
- **Python**: version 3.6 to 3.9.
|
||||||
|
- **Backends**: SQLite, PostgreSQL, MariaDB (version 10.3.2 or above),
|
||||||
|
Memory.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Do you wish to contribute to IHateMoney? Fantastic! There's a lot of
|
||||||
|
very useful help on the official [contributing][] page.
|
||||||
|
|
||||||
|
You can also [donate some money][3]. All funds will be used to maintain
|
||||||
|
the [hosted version][].
|
||||||
|
|
||||||
|
## Translation status
|
||||||
|
|
||||||
|
[![Translation status for each language][]][2]
|
||||||
|
|
||||||
|
[1]: https://github.com/spiral-project/ihatemoney/actions/workflows/test-docs.yml
|
||||||
|
[2]: https://hosted.weblate.org/engage/i-hate-money/?utm_source=widget
|
||||||
|
[3]: https://liberapay.com/IHateMoney/donate
|
||||||
|
[GitHub Actions Status]: https://github.com/spiral-project/ihatemoney/actions/workflows/test-docs.yml/badge.svg
|
||||||
|
[Translation status from Weblate]: https://hosted.weblate.org/widgets/i-hate-money/-/i-hate-money/svg-badge.svg
|
||||||
|
[Donate]: https://img.shields.io/liberapay/receives/IHateMoney.svg?logo=liberapay
|
||||||
|
[Online documentation]: https://ihatemoney.readthedocs.org
|
||||||
|
[Hosted version]: https://ihatemoney.org
|
||||||
|
[Mailing list]: https://mailman.alwaysdata.com/postorius/lists/info.ihatemoney.org/
|
||||||
|
[contributing]: https://ihatemoney.readthedocs.io/en/latest/contributing.html
|
||||||
|
[Translation status for each language]: https://hosted.weblate.org/widgets/i-hate-money/-/i-hate-money/multi-blue.svg
|
49
README.rst
49
README.rst
|
@ -1,49 +0,0 @@
|
||||||
I hate money
|
|
||||||
############
|
|
||||||
|
|
||||||
.. image:: https://github.com/spiral-project/ihatemoney/actions/workflows/test-docs.yml/badge.svg
|
|
||||||
:target: https://github.com/spiral-project/ihatemoney/actions/workflows/test-docs.yml
|
|
||||||
:alt: GitHub Actions Status
|
|
||||||
|
|
||||||
.. image:: https://hosted.weblate.org/widgets/i-hate-money/-/i-hate-money/svg-badge.svg
|
|
||||||
:target: https://hosted.weblate.org/engage/i-hate-money/?utm_source=widget
|
|
||||||
:alt: Translation status from Weblate
|
|
||||||
|
|
||||||
.. image:: https://img.shields.io/liberapay/receives/IHateMoney.svg?logo=liberapay
|
|
||||||
:target: https://liberapay.com/IHateMoney/donate
|
|
||||||
:alt: Donate
|
|
||||||
|
|
||||||
*I hate money* is a web application made to ease shared budget management.
|
|
||||||
It keeps track of who bought what, when, and for whom; and helps to settle the
|
|
||||||
bills.
|
|
||||||
|
|
||||||
* `Online documentation <https://ihatemoney.readthedocs.org>`_
|
|
||||||
* `Hosted version <https://ihatemoney.org>`_
|
|
||||||
* `Mailing list <https://mailman.alwaysdata.com/postorius/lists/info.ihatemoney.org/>`_
|
|
||||||
(to get updates when needed).
|
|
||||||
|
|
||||||
The code is distributed under a BSD *beerware* derivative: if you meet the
|
|
||||||
people in person and you want to pay them a craft beer, you are highly
|
|
||||||
encouraged to do so.
|
|
||||||
|
|
||||||
Requirements
|
|
||||||
============
|
|
||||||
|
|
||||||
* **Python**: version 3.6 to 3.9.
|
|
||||||
* **Backends**: SQLite, PostgreSQL, MariaDB (version 10.3.2 or above), Memory.
|
|
||||||
|
|
||||||
Contributing
|
|
||||||
============
|
|
||||||
|
|
||||||
Do you wish to contribute to IHateMoney? Fantastic! There's a lot of very
|
|
||||||
useful help on the official `contributing
|
|
||||||
<https://ihatemoney.readthedocs.io/en/latest/contributing.html>`_ page.
|
|
||||||
|
|
||||||
You can also `donate some money <https://liberapay.com/IHateMoney/donate>`_. All funds will be used to maintain the `hosted version <https://ihatemoney.org>`_.
|
|
||||||
|
|
||||||
Translation status
|
|
||||||
==================
|
|
||||||
|
|
||||||
.. image:: https://hosted.weblate.org/widgets/i-hate-money/-/i-hate-money/multi-blue.svg
|
|
||||||
:target: https://hosted.weblate.org/engage/i-hate-money/?utm_source=widget
|
|
||||||
:alt: Translation status for each language
|
|
Loading…
Reference in a new issue