From f654ebf2dfb11c201ea5d64e2e53f516ff4f6277 Mon Sep 17 00:00:00 2001 From: Lance Edgar Date: Fri, 13 Sep 2024 18:44:16 -0500 Subject: [PATCH] docs: use markdown for readme file --- .gitignore | 2 ++ README.md | 12 ++++++++++++ README.rst | 16 ---------------- setup.py | 2 +- 4 files changed, 15 insertions(+), 17 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/.gitignore b/.gitignore index 883c935..a23df04 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,3 @@ +*~ +*.pyc rattail_dash.egg-info/ \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..c68b306 --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ + +# rattail-dash + +This package contains some helper logic, as well as a sample app, to +show how a [Dash](https://dash.plot.ly/) app can display Rattail (and +specifically Trainwreck) data. + +Rattail is a retail software framework, released under the GNU General +Public License. + +Please see Rattail's [home page](https://rattailproject.org/) for more +information. diff --git a/README.rst b/README.rst deleted file mode 100644 index 4c7ac5a..0000000 --- a/README.rst +++ /dev/null @@ -1,16 +0,0 @@ - -rattail-dash -============ - -This package contains some helper logic, as well as a sample app, to -show how a `Dash`_ app can display Rattail (and specifically -Trainwreck) data. - -.. _Dash: https://dash.plot.ly/ - -Rattail is a retail software framework, released under the GNU General -Public License. - -Please see Rattail's `home page`_ for more information. - -.. _`home page`: https://rattailproject.org/ diff --git a/setup.py b/setup.py index 86c1f0c..fd2e1af 100644 --- a/setup.py +++ b/setup.py @@ -27,7 +27,7 @@ from setuptools import setup, find_packages here = os.path.abspath(os.path.dirname(__file__)) exec(open(os.path.join(here, 'rattail_dash', '_version.py')).read()) -README = open(os.path.join(here, 'README.rst')).read() +README = open(os.path.join(here, 'README.md')).read() requires = [