-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathindex.html
190 lines (174 loc) · 7.18 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>dn-m</title>
<link rel="stylesheet" type="text/css" href="../assets/css/jazzy.css">
<link rel="stylesheet" type="text/css" href="../assets/css/highlight.css">
<meta charset="utf-8">
<script src="../assets/js/jquery.min.js" defer></script>
<script src="../assets/js/jazzy.js" defer></script>
</head>
<body>
<a title="dn-m | Documentation Home"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="index.html">
dn-m Docs
</a>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="https://github.com/dn-m/">
<img class="header-icon" src="../assets/img/gh.png">
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="https://dn-m.github.io">dn-m</a>
<img class="carat" src="../assets/img/carat.png">
dn-m
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name" id="NotationView">
<a href="Packages/NotationView/index.html" class="nav-group-name-link">NotationView</span>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Packages/NotationView/Modules/PlotView/index.html">PlotView</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Packages/NotationView/Modules/RhythmView/index.html">RhythmView</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Packages/NotationView/Modules/ScoreView/index.html">ScoreView</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Packages/NotationView/Modules/StaffView/index.html">StaffView</a>
</li>
</ul>
</li>
<li class="nav-group-name" id="NotationModel">
<a href="Packages/NotationModel/index.html" class="nav-group-name-link">NotationModel</span>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Packages/NotationModel/Modules/PlotModel/index.html">PlotModel</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Packages/NotationModel/Modules/SpelledPitch/index.html">SpelledPitch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Packages/NotationModel/Modules/SpelledRhythm/index.html">SpelledRhythm</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Packages/NotationModel/Modules/StaffModel/index.html">StaffModel</a>
</li>
</ul>
</li>
<li class="nav-group-name" id="Music">
<a href="Packages/Music/index.html" class="nav-group-name-link">Music</span>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Packages/Music/Modules/Articulations/index.html">Articulations</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Packages/Music/Modules/Duration/index.html">Duration</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Packages/Music/Modules/Dynamics/index.html">Dynamics</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Packages/Music/Modules/MusicModel/index.html">MusicModel</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Packages/Music/Modules/Pitch/index.html">Pitch</a>
</li>
</ul>
</li>
<li class="nav-group-name" id="Graphics">
<a href="Packages/Graphics/index.html" class="nav-group-name-link">Graphics</span>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Packages/Graphics/Modules/Geometry/index.html">Geometry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Packages/Graphics/Modules/GraphicsTesting/index.html">GraphicsTesting</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Packages/Graphics/Modules/Path/index.html">Path</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Packages/Graphics/Modules/QuartzAdapter/index.html">QuartzAdapter</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Packages/Graphics/Modules/Rendering/index.html">Rendering</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Packages/Graphics/Modules/SVG/index.html">SVG</a>
</li>
</ul>
</li>
<li class="nav-group-name" id="Math">
<a href="Packages/Math/index.html" class="nav-group-name-link">Math</span>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Packages/Math/Modules/Math/index.html">Math</a>
</li>
</ul>
</li>
<li class="nav-group-name" id="Structure">
<a href="Packages/Structure/index.html" class="nav-group-name-link">Structure</span>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Packages/Structure/Modules/Algebra/index.html">Algebra</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Packages/Structure/Modules/Algorithms/index.html">Algorithms</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Packages/Structure/Modules/DataStructures/index.html">DataStructures</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Packages/Structure/Modules/Destructure/index.html">Destructure</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content">
<h1>dn-m docs</h1>
<p>Welcome to the <strong>dn-m</strong> (dynamic notation for music) project. Here you will find documentation generated directly from the source code.</p>
<h2>Packages</h2>
<p>The <strong>dn-m</strong> project currently consists of seven packages (each containing one or more modules): </p>
<ul>
<li><a href="Packages/Structure/index.html"><code>Structure</code></a></li>
<li><a href="Packages/Math/index.html"><code>Math</code></a></li>
<li><a href="Packages/Music/index.html"><code>Music</code></a></li>
<li><a href="Packages/NotationModel/index.html"><code>NotationModel</code></a></li>
<li><a href="Packages/Graphics/index.html"><code>Graphics</code></a></li>
<li><a href="Packages/NotationView/index.html"><code>NotationView</code></a></li>
<li><a href="Packages/Time/index.html"><code>Time</code></a></li>
</ul>
<p>The packages compose with and build upon each other:</p>
<p><img src="assets/img/packages.png" alt="Packages"></p>
<h2>Development</h2>
<p>The codebase for the <strong>dn-m</strong> project is written in the Swift language, and requires Swift version <strong>4.2</strong>.</p>
<h3>Installation</h3>
<p>The packages within the <strong>dn-m</strong> project are managed by the <a href="https://swift.org/package-manager/">Swift Package Manager</a>.</p>
<p>You can clone any of the repositories from the command line. For example, to work on the <code>Music</code> package, you can do the following:</p>
<p><code>git clone https://github.com/dn-m/Music && cd Music</code></p>
<p>For fun, give things a test:</p>
<p><code>swift test</code></p>
<p>This will update and build all of the dependencies (e.g., the <code>Music</code> package depends on the <code>Math</code> and the <code>Structure</code> packages), and then run the unit tests.</p>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2019<a class="link" href="https://github.com/dn-m" target="_blank" rel="external">dn-m</a>. All rights reserved.</p>
</section>
</body>
</html>