Giter Club home page Giter Club logo

cheetsheet's Introduction

Cheetsheet

Cheetsheet is a method of taking text files in the Cheetsheet notation and outputting PDF files for use by musicians.

A Cheatsheet usually has only the information needed for the appropriate musician. For example, a rhythm guitarist may only need the "chord sheet" (the chord names listed above the lyrics), while a drummer may need only information about the structure of the song, with cues for sections, notes about the feel of a section, drum tab for interesting fills leading to the next section, etc.

License

Cheetsheet is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Cheetsheet is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Cheetsheet. If not, see http://www.gnu.org/licenses/.

Requirements

Cheetsheet requires Python 2.7+ and the following python modules:

  • ReportLab: module for PDF generation.
  • Markdown: for formatting text to HTML or other markup

Usage

Copy the template file (songs/.template.json) to a new file in the ''songs'' directory, and edit it. Once you have modified the file to have the correct sections, lyrics, etc then run the following command:

bin/cheetsheet songs/songname.json

This will create a new file named ''songs/songname.pdf''.

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.