Git Product home page Git Product logo

songbook's Introduction

Songbook - song book generator

Songbook is a command-line tool used to generate automatically a song book. Songbook accept songs in the chorpro file format with the following extension:

  • txt, chopro, cho, crd, pro, cpm

It currently support the following output formats:

  • HTML
  • TXT
  • PDF

alt text

Apple silicon M1 issues

To run correctly on Apple M1 type:

npm install --arch=x64

It will use Rosetta and download the right version of Electron needed by html5-to-pdf library.

Installation

Install globally using npm:

npm install songbook -g

After the installation, songbook command can be execute everywhere in your terminal.

Usage

songbook <songs_folder> <output_filename>

Options

-c, --chord          	 							Show song chords
-C, --column [count]   							Layout column count (default 2)
-f, --font-size [size], 						CSS font-size (default 14px)
-b, --avoid-page-break, 						Avoid page break inside song
-m, --margin [size]									Page margin (default 1cm)
-n, --song-number      							Add song number
-V, --version          							Print version
-r, --replace-chorus [chorusLabel]	Replace chorus with a label (default 'CHORUS')
-o, --one-song-per-column						Print one song per column
-h, --help             							Print usage information

songbook's People

Contributors

pixy79 avatar

Stargazers

 avatar  avatar  avatar

songbook's Issues

Improve README.md

Improve README.md adding a specific example usage and some images to shown the output result.

Options to display only the first chorus

Display only the first chorus, and, for the chorus, if they are identical to the first one, replace with a common label (i.e. 'Chorus').
The label can be specified as an option.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.