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
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.
3267 Commits
6 Branches
56 Tags
50 MiB
 
 
 
 
Tree: 69abfcc9ee
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '69abfcc9ee'
${ noResults }
Oliverpool 69abfcc9ee
remove_keys is now useless 		9 years ago
examples Complete schema 9 years ago
patacrep remove_keys is now useless 9 years ago
test Merge schema and default arguments 9 years ago
windows Updating windows installation script 10 years ago
.appveyor.yml Clean appveyor.yml comments 9 years ago
.gitignore Add tox files to gitignore 10 years ago
.travis.yml Disable LaTeX installation on Travis since the tests are skipped 9 years ago
LICENSE import of the songbook source tree. 16 years ago
NEWS.md Syntax fixes 9 years ago
README.rst Gather badges at the beginning of the readme 9 years ago
Requirements.txt Simplify Requirements.txt 9 years ago
pylintrc [pylint] Hiding information message from pylint 9 years ago
setup.py Add pyyaml dependency 9 years ago
songbook Add a purgecache command to the songbook bash 9 years ago
stdeb.cfg [WIP] Debian package 10 years ago
texlive_packages.txt etoolbox is required for patadata 9 years ago
tox.ini Only the Continuous Integration is verbose 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 licence
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

Or for the latest version::

    pip3 install https://github.com/patacrep/patacrep/archive/master.zip

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.sb>
    <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/.

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-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