mirror of https://github.com/patacrep/patacrep.git
Engine for LaTeX songbooks
http://www.patacrep.com
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
sgelis
7c19c63674
|
1 year ago | |
|---|---|---|
| examples | 2 years ago | |
| patacrep | 1 year ago | |
| test | 1 year ago | |
| .appveyor.yml | 8 years ago | |
| .gitignore | 8 years ago | |
| .travis.yml | 8 years ago | |
| LICENSE | 16 years ago | |
| Makefile | 7 years ago | |
| NEWS.md | 8 years ago | |
| README.rst | 1 year ago | |
| Requirements.txt | 9 years ago | |
| patatools | 8 years ago | |
| pylintrc | 7 years ago | |
| setup.py | 1 year ago | |
| songbook | 8 years ago | |
| stdeb.cfg | 9 years ago | |
| texlive_packages.txt | 8 years ago | |
| tox.ini | 9 years ago | |
README.rst
Patacrep, a songbook compilation chain
======================================
|sources| |pypi| |documentation| |license|
|build-travis| |build-appveyor|
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 license
is precised in the header.
Python version
--------------
Patacrep is only compatible with Python > 3.3.
Installation
------------
Using pip
^^^^^^^^^
For the stable version, as simple as::
pip3 install patacrep
And upgrade to the latest release::
pip3 install patacrep -U
Or for the latest version::
pip3 install https://github.com/patacrep/patacrep/archive/master.zip
Details about the dependecies are in the `documentation <#documentation>`_.
For developement
^^^^^^^^^^^^^^^^
Clone Patacrep repos::
git clone git://github.com/patacrep/patacrep.git
cd patacrep
pip3 install -r Requirements.txt
python3 setup.py develop
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.yaml>
<pdfreader> <songbook_file.pdf>
Look for existing songbook files in `patadata <http://github.com/patacrep/patadata>`_.
Documentation
-------------
The full documentation is hosted by readthedoc, here : http://patacrep.readthedocs.org/ (currently only in french).
Contact & Forums
----------------
* https://github.com/patacrep/patacrep/issues
.. |documentation| image:: http://readthedocs.org/projects/patacrep/badge
:target: http://patacrep.readthedocs.org
.. |pypi| image:: https://img.shields.io/pypi/v/patacrep.svg
:target: http://pypi.python.org/pypi/patacrep
.. |license| image:: https://img.shields.io/pypi/l/patacrep.svg
:target: http://www.gnu.org/licenses/gpl-2.0.html
.. |sources| image:: https://img.shields.io/badge/sources-patacrep-brightgreen.svg
:target: http://github.com/patacrep/patacrep
.. |build-travis| image:: https://img.shields.io/travis-ci/patacrep/patacrep/master.svg?label=GNU/Linux
:target: https://travis-ci.org/patacrep/patacrep/branches
.. |build-appveyor| image:: https://img.shields.io/appveyor/ci/oliverpool/patacrep/master.svg?label=Windows
:target: https://ci.appveyor.com/project/oliverpool/patacrep/branch/master