diff --git a/README.md b/README.md new file mode 100644 index 00000000..337e1d2d --- /dev/null +++ b/README.md @@ -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 diff --git a/README.rst b/README.rst deleted file mode 100644 index e3e20e4e..00000000 --- a/README.rst +++ /dev/null @@ -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 `_ -* `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 `_. All funds will be used to maintain the `hosted version `_. - -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