hendrik
/
patacrep
mirror of https://github.com/patacrep/patacrep.git
1
0
Fork 0
Code Issues Releases Wiki Activity
Engine for LaTeX songbooks http://www.patacrep.com
3120 Commits
6 Branches
56 Tags
50 MiB
 
 
 
 
Tree: 6805d2d823
Louis 6805d2d823
Merge 53e8307759 into 5e60aa17be 		10 years ago
examples Use language code everywhere 10 years ago
patacrep Merge 53e8307759c3491764223b25ea6fd9d552a54508 into 5e60aa17be2013b979d68ca7aded3c6a5f36c5ec 10 years ago
test Merge branch 'master' into veyor_test 10 years ago
windows Updating windows installation script 11 years ago
.appveyor.yml Merge 53e8307759c3491764223b25ea6fd9d552a54508 into 5e60aa17be2013b979d68ca7aded3c6a5f36c5ec 10 years ago
.gitignore Add tox files to gitignore 10 years ago
.travis.yml Disable LaTeX installation on Travis since the tests are skipped 10 years ago
LICENSE import of the songbook source tree. 17 years ago
NEWS.md Typo 11 years ago
README.rst Typo 10 years ago
Requirements.txt [test] Using tox 10 years ago
pylintrc [pylint] Hiding information message from pylint 10 years ago
setup.py Move the jinja templates into the data folder 10 years ago
songbook [test] Add compilation tests 10 years ago
stdeb.cfg [WIP] Debian package 11 years ago
tox.ini Pass APPVEYOR env var 10 years ago

README.rst 

Patacrep, a songbook compilation chain
======================================

|sources| |build| |pypi| |documentation| |license|

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

.. |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| image:: https://travis-ci.org/patacrep/patacrep.svg?branch=master
  :target: https://travis-ci.org/patacrep/patacrep