From 3cbfc4f5c9bf5a2eb1bac9e2f88784a70dca41ed Mon Sep 17 00:00:00 2001 From: Louis Date: Sun, 25 Jan 2015 22:31:47 +0100 Subject: [PATCH] README is well rendered both in github and Pypi --- README.rst | 63 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ readme.md | 61 ---------------------------------------------------- setup.py | 2 ++ 3 files changed, 65 insertions(+), 61 deletions(-) create mode 100644 README.rst delete mode 100644 readme.md diff --git a/README.rst b/README.rst new file mode 100644 index 00000000..7af8b663 --- /dev/null +++ b/README.rst @@ -0,0 +1,63 @@ +Patacrep, a songbook compilation chain +====================================== + +This package provides a compilation toolchain that produce LaTeX +songbook using the LaTeX songs package. A new LaTeX document class is +provided to allow specific customisation and new command like embedded +guitar tabs or lilypond sheets. + +Document are subject to the GNU GPLv2 except if another licence +is precised in the header. + +Python version +-------------- + +Patacrep is only compatible with Python > 3.3. + +Installation +------------ + +Using pip +^^^^^^^^^ + +As simple as:: + + pip3 install patacrep + +For developement +^^^^^^^^^^^^^^^^ + +Clone Patacrep repos:: + + git clone git://github.com/patacrep/patacrep.git + cd patacrep + pip3 install -r Requirements.txt + python3 setup.py install + +Quick and dirty Debian (and Ubuntu?) package +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This requires `stdeb `_ to be installed:: + + python setup.py --command-packages=stdeb.command bdist_deb + sudo dpkg -i deb_dist/python3-patacrep_4.0.0-1_all.deb + +Run +--- + +:: + + songbook + + +Look for existing songbook files in `patadata `_. + +More informations +----------------- + +The full documentation is hosted by readthedoc, here : http://patacrep.readthedocs.org/. + +Contact & Forums +---------------- + +* http://www.patacrep.com/forum diff --git a/readme.md b/readme.md deleted file mode 100644 index d293c596..00000000 --- a/readme.md +++ /dev/null @@ -1,61 +0,0 @@ -# Patacrep, a songbook compilation chain - -This package provides a compilation toolchain that produce LaTeX -songbook using the LaTeX songs package. A new LaTeX document class is -provided to allow specific customisation and new command like embedded -guitar tabs or lilypond sheets. - -Document are subject to the GNU GPLv2 except if another licence -is precised in the header. - -# Python version - -Patacrep is only compatible with Python > 3.3. - -# Installation - -## Using pip - -As simple as - -``` -pip3 install patacrep -``` - -## For developement - -Clone Patacrep repos: - -``` -git clone git://github.com/patacrep/patacrep.git -cd patacrep -pip3 install -r Requirements.txt -python3 setup.py install -``` - -## Quick and dirty Debian (and Ubuntu?) package - -This requires [stdeb](https://github.com/astraw/stdeb) to be installed. - -``` -python setup.py --command-packages=stdeb.command bdist_deb -sudo dpkg -i deb_dist/python3-patacrep_4.0.0-1_all.deb -``` - - -# Run - -``` -songbook - -``` - -Look for existing songbook files in [patadata](http://github.com/patacrep/patadata) - -# More informations - -The full documentation is hosted by readthedoc, here : http://patacrep.readthedocs.org/ - -# Contact & Forums - -* http://www.patacrep.com/forum diff --git a/setup.py b/setup.py index 3313371f..d5b90fdc 100755 --- a/setup.py +++ b/setup.py @@ -38,4 +38,6 @@ setup( "Topic :: Utilities", ], platforms=["GNU/Linux", "Windows", "MacOsX"] + platforms=["GNU/Linux", "Windows", "MacOsX"], + long_description = open("README.rst", "r").read(), )