Browse Source

README is well rendered both in github and Pypi

pull/76/head
Louis 10 years ago
parent
commit
3cbfc4f5c9
  1. 63
      README.rst
  2. 61
      readme.md
  3. 2
      setup.py

63
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 <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 <songbook_file.sb>
<pdfreader> <songbook_file.pdf>
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

61
readme.md

@ -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 <songbook_file.sb>
<pdfreader> <songbook_file.pdf>
```
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

2
setup.py

@ -38,4 +38,6 @@ setup(
"Topic :: Utilities", "Topic :: Utilities",
], ],
platforms=["GNU/Linux", "Windows", "MacOsX"] platforms=["GNU/Linux", "Windows", "MacOsX"]
platforms=["GNU/Linux", "Windows", "MacOsX"],
long_description = open("README.rst", "r").read(),
) )

Loading…
Cancel
Save