docs: use markdown for readme file
This commit is contained in:
parent
333d8a513e
commit
f654ebf2df
2
.gitignore
vendored
2
.gitignore
vendored
|
@ -1 +1,3 @@
|
|||
*~
|
||||
*.pyc
|
||||
rattail_dash.egg-info/
|
12
README.md
Normal file
12
README.md
Normal file
|
@ -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.
|
16
README.rst
16
README.rst
|
@ -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/
|
2
setup.py
2
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 = [
|
||||
|
|
Loading…
Reference in a new issue