UNPKG

3.65 kBHTMLView Raw
1<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <title>JSDoc: Home</title>
6
7 <script src="scripts/prettify/prettify.js"> </script>
8 <script src="scripts/prettify/lang-css.js"> </script>
9 <!--[if lt IE 9]>
10 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13 <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14</head>
15
16<body>
17
18<div id="main">
19
20 <h1 class="page-title">Home</h1>
21
22
23
24
25
26
27
28
29 <h3> </h3>
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45 <section>
46 <article><h1>musicjson2abc</h1><p><a href="https://travis-ci.org/freakimkaefig/musicjson2abc"><img src="https://travis-ci.org/freakimkaefig/musicjson2abc.svg?branch=master" alt="Build Status"></a>
47<a href="https://badge.fury.io/js/musicjson2abc"><img src="https://badge.fury.io/js/musicjson2abc.svg" alt="npm version"></a></p>
48<p>A command-line tool to convert musicJSON to abc notation
49An example of the used format of json is in <a href="https://github.com/freakimkaefig/musicjson2abc/blob/master/example.json">example.json</a>.</p>
50<h2>Getting started</h2><p>Install the module with:</p>
51<pre class="prettyprint source lang-sh"><code>npm install -g musicjson2abc</code></pre><h2>Example</h2><pre class="prettyprint source lang-javascript"><code>var musicjson2abc = require('musicjson2abc');
52
53var abc = musicjson2abc.convert2Abc('{&quot;id&quot;:&quot;123456&quot;,&quot;attributes&quot;:{&quot;divisions&quot;:4,&quot;clef&quot;:{&quot;sign&quot;:&quot;G&quot;,&quot;line&quot;:2},&quot;key&quot;:{&quot;fifths&quot;:-1},&quot;time&quot;:{&quot;beats&quot;:3,&quot;beat-type&quot;:4}},&quot;measures&quot;:[{&quot;attributes&quot;:{&quot;repeat&quot;:{&quot;left&quot;:false,&quot;right&quot;:false}},&quot;notes&quot;:[{&quot;type&quot;:&quot;quarter&quot;,&quot;duration&quot;: 4,&quot;rest&quot;: false,&quot;pitch&quot;: {&quot;step&quot;:&quot;C&quot;,&quot;octave&quot;:4,&quot;alter&quot;:0,&quot;accidental&quot;: &quot;flat&quot;},&quot;$$hashKey&quot;:&quot;object:1255&quot;}]}]}');
54
55console.log(abc);
56
57// output:
58// X:123456
59// T:123456
60// M:3/4
61// L:1/16
62// K:F
63// _C4|</code></pre><h2>Command line tool</h2><p>The command <code>musicjson2abc</code> accepts filepaths for input and output files.</p>
64<pre class="prettyprint source"><code>$ musicjson2abc --help
65
66 Usage: musicjson2abc [options] &lt;input> [output]
67
68 Options:
69
70 -h, --help output usage information
71 -V, --version output the version number
72
73 Examples:
74
75 $ musicjson2abc input.json output.abc
76 $ musicjson2abc example.json example.abc
77
78 Hint:
79
80 The input file should be a valid musicJSON file
81 The output file will become a valid abc file. May overwrite existing files.</code></pre><h2>License</h2><p>Licensed under the MIT License. See <a href="https://github.com/freakimkaefig/musicjson2abc/blob/master/LICENSE">LICENSE</a> for further information.</p></article>
82 </section>
83
84
85
86
87
88
89</div>
90
91<nav>
92 <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#convert2Abc">convert2Abc</a></li><li><a href="global.html#getAbcKey">getAbcKey</a></li><li><a href="global.html#getAbcNote">getAbcNote</a></li><li><a href="global.html#getAbcString">getAbcString</a></li></ul>
93</nav>
94
95<br class="clear">
96
97<footer>
98 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Apr 07 2016 18:36:08 GMT+0200 (Mitteleuropäische Sommerzeit)
99</footer>
100
101<script> prettyPrint(); </script>
102<script src="scripts/linenumber.js"> </script>
103</body>
104</html>
\No newline at end of file