Migrate README to rst

This commit is contained in:
Raoul Snyman 2023-04-11 13:51:59 -07:00
parent fa8146e8c4
commit 247ed94362
2 changed files with 22 additions and 21 deletions

View File

@ -1,21 +0,0 @@
# MapMakr
[![PyPI - Version](https://img.shields.io/pypi/v/mapmakr.svg)](https://pypi.org/project/mapmakr)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mapmakr.svg)](https://pypi.org/project/mapmakr)
-----
**Table of Contents**
- [Installation](#installation)
- [License](#license)
## Installation
```console
pip install mapmakr
```
## License
`mapmakr` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

22
README.rst Normal file
View File

@ -0,0 +1,22 @@
MapMakr
=======
**Table of Contents**
- `Installation <#installation>`_
- `License <#license>`_
Installation
------------
.. code-block:: sh
pip install mapmakr
License
-------
``mapmakr`` is distributed under the terms of the `MIT`_ license.
.. _MIT: https://spdx.org/licenses/MIT.html