Skip to content
Snippets Groups Projects
Unverified Commit 9856d755 authored by mirabilos's avatar mirabilos Committed by mirabilos
Browse files

improve documentation or rendering thereof 

tested with python3-readme-renderer and:

(cat README.rst; echo; cat MMLFILE.rst; echo; cat CHANGELOG.rst) \
    >/tmp/x.rst && python3 -m readme_renderer /tmp/x.rst -o - | \
    (printf '%s\n' '<!DOCTYPE html>' '<html lang="en" dir="ltr">' \
    '  <head>' \
    '    <link rel="stylesheet" href="https://pypi.org/static/css/warehouse-ltr.17bfe083.css">' \
    '  </head><body style="margin:1em;"><div id="description" class="project-description">'; \
    cat) >/tmp/x.html; iceweasel /tmp/x.html
parent f7cec850
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
README.rst
+ 14
− 7
View file @ 9856d755
MMLlib - Modern library for handling Music Macro Language MMLlib — Modern library for handling Music Macro Language
========================================================= =========================================================
About About
...@@ -26,7 +26,7 @@ The library currently contains functions to: ...@@ -26,7 +26,7 @@ The library currently contains functions to:
- a duration estimate and the number of tracks are added to the metadata - a duration estimate and the number of tracks are added to the metadata
- return a list of tuples (frequency, duration) to play (in a threaded - return a list of tuples (frequency, duration) to play (in a threaded
interpreter, such as Floppi-Music) interpreter, such as Floppi-Music)
- bar lines are indicated separately as integer ``1`` - bar lines are indicated separately as integer ``1`` in the playlist
- return an event-oriented list of measures / bars across all tracks; - return an event-oriented list of measures / bars across all tracks;
each measure has a duration and a list of time-fixed tone on/off each measure has a duration and a list of time-fixed tone on/off
events; facilitates playing in non-threaded interpreters and, events; facilitates playing in non-threaded interpreters and,
...@@ -65,16 +65,23 @@ Testsuite ...@@ -65,16 +65,23 @@ Testsuite
The testsuite can be run with one of the following commands: The testsuite can be run with one of the following commands:
- ``python3 setup.py test`` (3.x) or ``python setup.py test`` (2.5+) - with setuptools (note that this is deprecated in recent versions;
(note that this is deprecated in recent versions of setuptools;
use one of the other methods if it fails) use one of the other methods if it fails)
- ``python3 -m unittest`` (3.x)
- ``python -m unittest discover`` (2.7+) - ``python3 setup.py test`` (3.x)
- ``python setup.py test`` (2.5+)
- with unittest
- ``python3 -m unittest`` (3.x)
- ``python -m unittest discover`` (2.7+)
- using another suitable testsuite runner
Examples Examples
-------- --------
Some example extended MML files are contained within the examples/ Some example extended MML files are contained within the ``examples/``
directory, in lieu of better documentation for the extended format, in directory, in lieu of better documentation for the extended format, in
addition to the `MML format documentation addition to the `MML format documentation
<http://www.mirbsd.org/man4/spkr>`__. <http://www.mirbsd.org/man4/spkr>`__.
......
setup.py
+ 1
− 1
View file @ 9856d755
...@@ -43,7 +43,7 @@ setup( ...@@ -43,7 +43,7 @@ setup(
name = 'MMLlib', name = 'MMLlib',
version = '1.4', version = '1.4',
description = 'Modern library for handling Music Macro Language', description = 'Modern library for handling Music Macro Language',
long_description = long_description, long_description = long_description.strip(),
license = 'MirOS', license = 'MirOS',
url = 'https://edugit.org/nik/mmllib', url = 'https://edugit.org/nik/mmllib',
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment