From adf9464af5900c3f75923e85d5ebdbaf98761052 Mon Sep 17 00:00:00 2001 From: Louis Date: Tue, 3 Nov 2015 03:38:20 +0100 Subject: [PATCH 01/10] Add Appveyor shield --- README.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 97e5d54a..c2f5effc 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,9 @@ Patacrep, a songbook compilation chain ====================================== -|sources| |build| |pypi| |documentation| |license| +|sources| |pypi| |documentation| |license| + +GNU/Linux: |build-travis| Windows: |build-appveyor| This package provides a compilation toolchain that produce LaTeX songbook using the LaTeX songs package. A new LaTeX document class is @@ -72,5 +74,7 @@ Contact & Forums :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 +.. |build-travis| image:: https://travis-ci.org/patacrep/patacrep.svg?branch=master :target: https://travis-ci.org/patacrep/patacrep +.. |build-appveyor| image:: https://img.shields.io/appveyor/ci/patacrep/patacrep.svg + :target: https://ci.appveyor.com/project/oliverpool/patacrep From 24a864547d4432401715789042a487a076dd509a Mon Sep 17 00:00:00 2001 From: Louis Date: Tue, 3 Nov 2015 03:39:32 +0100 Subject: [PATCH 02/10] [README] Fix appveyor image url --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index c2f5effc..359a97b0 100644 --- a/README.rst +++ b/README.rst @@ -76,5 +76,5 @@ Contact & Forums :target: http://github.com/patacrep/patacrep .. |build-travis| image:: https://travis-ci.org/patacrep/patacrep.svg?branch=master :target: https://travis-ci.org/patacrep/patacrep -.. |build-appveyor| image:: https://img.shields.io/appveyor/ci/patacrep/patacrep.svg +.. |build-appveyor| image:: https://img.shields.io/appveyor/ci/oliverpool/patacrep.svg :target: https://ci.appveyor.com/project/oliverpool/patacrep From bed2005051973c560cd0d20dfae5be1ff2d77666 Mon Sep 17 00:00:00 2001 From: oliverpool Date: Tue, 3 Nov 2015 11:32:45 +0100 Subject: [PATCH 03/10] Embbed platform names in badges --- README.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 359a97b0..45c93177 100644 --- a/README.rst +++ b/README.rst @@ -1,9 +1,9 @@ Patacrep, a songbook compilation chain ====================================== -|sources| |pypi| |documentation| |license| +|sources| |pypi| |license| -GNU/Linux: |build-travis| Windows: |build-appveyor| +|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 @@ -74,7 +74,7 @@ Contact & Forums :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://travis-ci.org/patacrep/patacrep.svg?branch=master +.. |build-travis| image:: https://img.shields.io/travis-ci/patacrep/patacrep.svg?label=GNU/Linux :target: https://travis-ci.org/patacrep/patacrep -.. |build-appveyor| image:: https://img.shields.io/appveyor/ci/oliverpool/patacrep.svg +.. |build-appveyor| image:: https://img.shields.io/appveyor/ci/oliverpool/patacrep.svg?label=Windows :target: https://ci.appveyor.com/project/oliverpool/patacrep From c8a2821f37f890ac1969c1c24339cbfc10ce5d22 Mon Sep 17 00:00:00 2001 From: oliverpool Date: Tue, 3 Nov 2015 11:36:39 +0100 Subject: [PATCH 04/10] Split the badges at relevant locations --- README.rst | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index 45c93177..b12f35bb 100644 --- a/README.rst +++ b/README.rst @@ -1,8 +1,7 @@ Patacrep, a songbook compilation chain ====================================== -|sources| |pypi| |license| - +|license| |build-travis| |build-appveyor| This package provides a compilation toolchain that produce LaTeX @@ -21,15 +20,15 @@ Patacrep is only compatible with Python > 3.3. Installation ------------ -Using pip -^^^^^^^^^ +Using pip |pypi| +^^^^^^^^^^^^^^^^ As simple as:: pip3 install patacrep -For developement -^^^^^^^^^^^^^^^^ +For developement |sources| +^^^^^^^^^^^^^^^^^^^^^^^^^^ Clone Patacrep repos:: @@ -56,8 +55,8 @@ Run Look for existing songbook files in `patadata `_. -More informations ------------------ +Documentation |documentation| +----------------------------- The full documentation is hosted by readthedoc, here : http://patacrep.readthedocs.org/. From cc7b4b1bfdfb8a1bafd67a2a1652a51ef4be377d Mon Sep 17 00:00:00 2001 From: oliverpool Date: Tue, 3 Nov 2015 11:38:08 +0100 Subject: [PATCH 05/10] Move licence badge --- README.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index b12f35bb..9225d3f8 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,6 @@ Patacrep, a songbook compilation chain ====================================== -|license| |build-travis| |build-appveyor| This package provides a compilation toolchain that produce LaTeX @@ -9,6 +8,8 @@ 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. +|license| + Document are subject to the GNU GPLv2 except if another licence is precised in the header. From 9a8761b85f1f43f9b9d51e3234b81aeeab78857c Mon Sep 17 00:00:00 2001 From: oliverpool Date: Tue, 3 Nov 2015 11:41:53 +0100 Subject: [PATCH 06/10] Build badges show master branch status --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 9225d3f8..481396ac 100644 --- a/README.rst +++ b/README.rst @@ -74,7 +74,7 @@ Contact & Forums :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.svg?label=GNU/Linux +.. |build-travis| image:: https://img.shields.io/travis-ci/patacrep/patacrep.svg?branch=master&label=GNU/Linux :target: https://travis-ci.org/patacrep/patacrep -.. |build-appveyor| image:: https://img.shields.io/appveyor/ci/oliverpool/patacrep.svg?label=Windows +.. |build-appveyor| image:: https://img.shields.io/appveyor/ci/oliverpool/patacrep.svg?branch=master&label=Windows :target: https://ci.appveyor.com/project/oliverpool/patacrep From e612ae19a9f46451f1e547a0d656182b89b9cb88 Mon Sep 17 00:00:00 2001 From: oliverpool Date: Tue, 3 Nov 2015 11:43:48 +0100 Subject: [PATCH 07/10] Correct master branch URL badge --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 481396ac..c034880d 100644 --- a/README.rst +++ b/README.rst @@ -74,7 +74,7 @@ Contact & Forums :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.svg?branch=master&label=GNU/Linux +.. |build-travis| image:: https://img.shields.io/travis-ci/patacrep/patacrep/master.svg?label=GNU/Linux :target: https://travis-ci.org/patacrep/patacrep -.. |build-appveyor| image:: https://img.shields.io/appveyor/ci/oliverpool/patacrep.svg?branch=master&label=Windows +.. |build-appveyor| image:: https://img.shields.io/appveyor/ci/oliverpool/patacrep/master.svg?label=Windows :target: https://ci.appveyor.com/project/oliverpool/patacrep From df04318bc02216c485f1308f8197a5f4db8526a8 Mon Sep 17 00:00:00 2001 From: oliverpool Date: Tue, 3 Nov 2015 11:49:20 +0100 Subject: [PATCH 08/10] Build badge links point to branch build status Travis doesn't support specific branch link (https://github.com/travis-ci/travis-ci/issues/1996) --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index c034880d..b830c052 100644 --- a/README.rst +++ b/README.rst @@ -75,6 +75,6 @@ Contact & Forums .. |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 + :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 + :target: https://ci.appveyor.com/project/oliverpool/patacrep/branch/master From b5b1b84d948fe6ec29a4136d842034005240c3c8 Mon Sep 17 00:00:00 2001 From: oliverpool Date: Tue, 3 Nov 2015 12:26:16 +0100 Subject: [PATCH 09/10] Improve installation instructions --- README.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index b830c052..e44ef785 100644 --- a/README.rst +++ b/README.rst @@ -24,10 +24,14 @@ Installation Using pip |pypi| ^^^^^^^^^^^^^^^^ -As simple as:: +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 |sources| ^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -36,7 +40,7 @@ Clone Patacrep repos:: git clone git://github.com/patacrep/patacrep.git cd patacrep pip3 install -r Requirements.txt - python3 setup.py install + python3 setup.py develop Quick and dirty Debian (and Ubuntu?) package ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ From fb55199d4fba8679d153b2b10dcb638818563842 Mon Sep 17 00:00:00 2001 From: oliverpool Date: Tue, 3 Nov 2015 14:02:02 +0100 Subject: [PATCH 10/10] Gather badges at the beginning of the readme --- README.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index e44ef785..da4c1660 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,8 @@ Patacrep, a songbook compilation chain ====================================== +|sources| |pypi| |documentation| |license| + |build-travis| |build-appveyor| This package provides a compilation toolchain that produce LaTeX @@ -8,8 +10,6 @@ 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. -|license| - Document are subject to the GNU GPLv2 except if another licence is precised in the header. @@ -21,8 +21,8 @@ Patacrep is only compatible with Python > 3.3. Installation ------------ -Using pip |pypi| -^^^^^^^^^^^^^^^^ +Using pip +^^^^^^^^^ For the stable version, as simple as:: @@ -32,8 +32,8 @@ Or for the latest version:: pip3 install https://github.com/patacrep/patacrep/archive/master.zip -For developement |sources| -^^^^^^^^^^^^^^^^^^^^^^^^^^ +For developement +^^^^^^^^^^^^^^^^ Clone Patacrep repos:: @@ -60,8 +60,8 @@ Run Look for existing songbook files in `patadata `_. -Documentation |documentation| ------------------------------ +Documentation +------------- The full documentation is hosted by readthedoc, here : http://patacrep.readthedocs.org/.