Reformatted README as reStructuredText
This commit is contained in:
parent
161dbf9864
commit
45416a4064
52
README.rst
Normal file
52
README.rst
Normal file
@ -0,0 +1,52 @@
|
||||
python-chordpro
|
||||
===============
|
||||
|
||||
``python-chordpro`` is a ChordPro parser, written in Python. The main difference between this module
|
||||
and other similar libraries is that ``python-chordpro`` parses ChordPro files down to the syllable
|
||||
level, enabling finer-grained control of the formatted output.
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
You can use ``pip`` to install ``python-chordpro``::
|
||||
|
||||
$ pip install python-chordpro
|
||||
|
||||
Example Usage
|
||||
-------------
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from chordpro import Song
|
||||
|
||||
song = Song('path/to/song.chordpro')
|
||||
|
||||
for verse in song.verses:
|
||||
print(verse.title)
|
||||
|
||||
Rendering
|
||||
---------
|
||||
|
||||
``python-chordpro`` comes with two renders, HTML and Text.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from chordpro.renderers.html import render
|
||||
|
||||
print(render(song))
|
||||
|
||||
|
||||
Command Line Interface
|
||||
----------------------
|
||||
|
||||
``python-chordpro`` also ships with a built-in command line interface which will read a ChordPro
|
||||
file and then render it using either the text or HTML renderer.
|
||||
|
||||
For example::
|
||||
|
||||
$ python-chordpro path/to/song.chordpro -f text -o song.txt
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
``python-chordpro`` is licensed under the MIT license. See the LICENSE file for more information.
|
Loading…
Reference in New Issue
Block a user