docs: use markdown for readme file

This commit is contained in:
Lance Edgar 2024-09-13 19:27:54 -05:00
parent 6058838239
commit b119a8eee5
3 changed files with 12 additions and 15 deletions

11
README.md Normal file
View file

@ -0,0 +1,11 @@
# rattail-fabric
Rattail is a retail software framework, released under the GNU General Public
License.
This package contains various utility functions for use with
[Fabric](http://www.fabfile.org/).
Please see Rattail's [home page](https://rattailproject.org/) for more
information.

View file

@ -1,14 +0,0 @@
rattail-fabric
==============
Rattail is a retail software framework, released under the GNU General Public
License.
This package contains various utility functions for use with `Fabric`_.
.. _`Fabric`: http://www.fabfile.org/
Please see Rattail's `home page`_ for more information.
.. _`home page`: https://rattailproject.org/

View file

@ -29,7 +29,7 @@ from setuptools import setup, find_packages
here = os.path.abspath(os.path.dirname(__file__)) here = os.path.abspath(os.path.dirname(__file__))
exec(open(os.path.join(here, 'rattail_fabric', '_version.py')).read()) exec(open(os.path.join(here, 'rattail_fabric', '_version.py')).read())
README = open(os.path.join(here, 'README.rst')).read() README = open(os.path.join(here, 'README.md')).read()
requires = [ requires = [