From fbc2560c5d82598d78b330aeddd7ac30c070fec0 Mon Sep 17 00:00:00 2001 From: Luthaf Date: Fri, 19 Dec 2014 20:49:37 +0100 Subject: [PATCH] Update Readme and NEWS for v4.0 --- NEWS | 68 -------------------------- NEWS.md | 113 +++++++++++++++++++++++++++++++++++++++++++ patacrep/__init__.py | 2 +- readme.md | 48 +++++++++--------- 4 files changed, 139 insertions(+), 92 deletions(-) delete mode 100644 NEWS create mode 100644 NEWS.md diff --git a/NEWS b/NEWS deleted file mode 100644 index 62413cc8..00000000 --- a/NEWS +++ /dev/null @@ -1,68 +0,0 @@ -songbook 3.7.2 - - (Louis) Undocumented bug corrections and improvements. - -songbook 3.4.7 to 3.7.1 - - Mainly new songs in the data (which was included in songbook at this - time), and a few undocumented bug corrections and improvements. - -songbook (v0.8) - - Undocumented. - -songbook (v0.7) - - (lohrun) New songbook format (not compatible with older version). - Changes have been made to the compilation toolchain that prevent - compilation of old format songbook. - (lohrun) Use LaTeX Songs package v2.10. - - -- Alexandre Dupas Sat, 17 Jul 2010 15:24:14 +0200 - -songbook (v0.6) - - (crep, lohrun) Corrections of mistakes and typos. - (lohrun) Use plain songs package v2.9 - (lohrun) Replace makeindex script with a new python version - (lohrun) Add script to produce the list of chords used in songs - (crep, lohrun) Correct chords and gtabs used in songs - (lohrun) Modification of the default geometry - (lohrun) Remove capos from the lyricbook - - -- Alexandre Dupas Fri, 11 Dec 2009 15:35:03 +0100 - -songbook (0.5) - - (crep, lohrun) Corrections of mistakes and typos. - (lohrun) Add a proper volume mechanism - (lohrun) Add volume-1 source containing about 165 songs - (crep) Add naheulbeuk special edition - (lohrun) Upgraded songs.sty with bits from songs package v2.9 - (lohrun) Add tabs option - (crep,lohrun) Add lilypond option - - -- Alexandre Dupas Tue, 18 Aug 2009 23:38:12 +0200 - -songbook (0.4) - - (crep, lohrun) Corrections of mistakes and typos. - (crep, lohrun) Add cover picture to each song - (lohrun) Update to the Songs Package v2.8 - (lohrun) Update makefile to be POSIX compilant - - -- Alexandre Dupas Sun, 31 May 2009 01:39:16 +0200 - -songbook (0.3) - - (crep) Corrections of a lot of mistakes. - (crep) Include image support. - (lohrun) Add make-html utility. - - -- Alexandre Dupas Sun, 15 Feb 2009 18:34:59 +0100 - -songbook (0.2) - - Initial version. - - -- Alexandre Dupas Sat, 11 Oct 2008 20:00:00 +0100 diff --git a/NEWS.md b/NEWS.md new file mode 100644 index 00000000..0e705821 --- /dev/null +++ b/NEWS.md @@ -0,0 +1,113 @@ +# patacrep 4.0.0 + +* Project gestion + * Name change [#39](http://github.com/patacrep/patacrep/issues/39 + * Renew of the developement team + * Separation engine/data + * The engine is the [current poject](http://github.com/patacrep/patacrep) + * Data have their [own project](http://github.com/patacrep/patadata) + * And so does [various tools](http://github.com/patacrep/pataextra) + +* Internal changes + * Complete migration to Python + * No more Makefiles + * Creation of a `songbook` command + * patacrep uses Python3 [#65](http://github.com/patacrep/patacrep/issues/65) + * Massive code refactoring and simplification + * [PEP8](http://legacy.python.org/dev/peps/pep-0008/) conformity + * Better LaTeX Packages + * Better langages handling + * Better errors handling + * Better code documentation (in comments) + * Caching song AST, which gave an improvement of 45s for the compilation of all patadata [#51](http://github.com/patacrep/patacrep/issues/51) + * Lot of small improvements + +* Installation + * All from PyPi ! You can now use pip to install/update/remove patacrep + +* Fonctionnalities + * Change the template engine [#9](http://github.com/patacrep/patacrep/issues/9) + * Ability to add user variables [#18](http://github.com/patacrep/patacrep/issues/18) + * Change the song inclusion syntaxe [#47](http://github.com/patacrep/patacrep/issues/47) + * It is now possible to include other things than songs + * You can write a plugins to include your own type of content + * Personalisaitons of the songbook is easier with patadata templates (font, paper, colors, column, ...) [#41](http://github.com/patacrep/patacrep/issues/41) + * You can change the number of columns [#41](http://github.com/patacrep/patacrep/issues/41) + * Lilypond + * On the fly lylipond files compilation + * Adapt partition size to the paper size [#19](http://github.com/patacrep/patacrep/issues/19) + * You can choos how to sort the songs [#36](http://github.com/patacrep/patacrep/issues/36) + * Easier song repertories management [#43](http://github.com/patacrep/patacrep/issues/43) and [#45](http://github.com/patacrep/patacrep/issues/45) + * You can have more than one data folder + * Better index customisation + * Better gestion of files encoding [#62](http://github.com/patacrep/patacrep/issues/62). + + +# songbook 3.7.2 + + (Louis) Undocumented bug corrections and improvements. + +# songbook 3.4.7 to 3.7.1 + + Mainly new songs in the data (which was included in songbook at this + time), and a few undocumented bug corrections and improvements. + +# songbook (v0.8) + + Undocumented. + +# songbook (v0.7) + + (lohrun) New songbook format (not compatible with older version). + Changes have been made to the compilation toolchain that prevent + compilation of old format songbook. + (lohrun) Use LaTeX Songs package v2.10. + + -- Alexandre Dupas Sat, 17 Jul 2010 15:24:14 +0200 + +# songbook (v0.6) + + (crep, lohrun) Corrections of mistakes and typos. + (lohrun) Use plain songs package v2.9 + (lohrun) Replace makeindex script with a new python version + (lohrun) Add script to produce the list of chords used in songs + (crep, lohrun) Correct chords and gtabs used in songs + (lohrun) Modification of the default geometry + (lohrun) Remove capos from the lyricbook + + -- Alexandre Dupas Fri, 11 Dec 2009 15:35:03 +0100 + +# songbook (0.5) + + (crep, lohrun) Corrections of mistakes and typos. + (lohrun) Add a proper volume mechanism + (lohrun) Add volume-1 source containing about 165 songs + (crep) Add naheulbeuk special edition + (lohrun) Upgraded songs.sty with bits from songs package v2.9 + (lohrun) Add tabs option + (crep,lohrun) Add lilypond option + + -- Alexandre Dupas Tue, 18 Aug 2009 23:38:12 +0200 + +# songbook (0.4) + + (crep, lohrun) Corrections of mistakes and typos. + (crep, lohrun) Add cover picture to each song + (lohrun) Update to the Songs Package v2.8 + (lohrun) Update makefile to be POSIX compilant + + -- Alexandre Dupas Sun, 31 May 2009 01:39:16 +0200 + +# songbook (0.3) + + (crep) Corrections of a lot of mistakes. + (crep) Include image support. + (lohrun) Add make-html utility. + + -- Alexandre Dupas Sun, 15 Feb 2009 18:34:59 +0100 + +# songbook (0.2) + + Initial version. + + -- Alexandre Dupas Sat, 11 Oct 2008 20:00:00 +0100 diff --git a/patacrep/__init__.py b/patacrep/__init__.py index 3f37b681..e63b5123 100644 --- a/patacrep/__init__.py +++ b/patacrep/__init__.py @@ -10,7 +10,7 @@ if sys.version_info < (3, 3): sys.exit(1) # Patacrep version. -__TUPLE_VERSION__ = (4, 0, 0, "alpha") +__TUPLE_VERSION__ = (4, 0, 0) __version__ = '.'.join([str(number) for number in __TUPLE_VERSION__]) # Directory containing shared data (default templates, custom LaTeX packages, diff --git a/readme.md b/readme.md index c97fef12..fb2301dd 100644 --- a/readme.md +++ b/readme.md @@ -1,6 +1,4 @@ -Songbook Compilation Chain - -# Description +# 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 @@ -12,38 +10,42 @@ is precised in the header. # Python version -Patacrep is compatible with Python 3. +Patacrep is only compatible with Python > 3.3. -# Download +# Installation -Clone Patacrep repos: +## Using pip -> git clone git://github.com/patacrep/patacrep.git -> git clone git://github.com/patacrep/patadata.git +As simple as -# Installation from source +``` +pip3 install patacrep +``` -Make sure you have [pip](https://pip.pypa.io/en/latest/) installed, and then run +## For developement -> pip install -r Requirements.txt -> python3 setup.py install +Clone Patacrep repos: -# Run +``` +git clone git://github.com/patacrep/patacrep.git +cd patacrep +pip3 install -r Requirements.txt +python3 setup.py install +``` -> /songbook -> +# Run -Look for existing songbook files in `/books/`. For example: +``` +songbook + +``` -> /songbook /books/songbook_en.sb -> songbook_en.pdf +Look for existing songbook files in [patadata](http://github.com/patacrep/patadata) -# Documentation +# More informations -- Compiled, but may be outdated: http://www.patacrep.com/data/documents/doc_en.pdf -- Documentation repository (to update the previous one): [patacrep-doc](http://github.com/patacrep/patacrep-doc) +The full documentation is hosted by readthedoc, here : http://patacrep.readthedocs.org/ # Contact & Forums -* http://www.patacrep.com -* crep@team-on-fire.com +* http://www.patacrep.com/forum