Add 'Library deployment' section.

grame-cncm · May 23, 2021 · 141feb2 · 141feb2
1 parent 476f7a1
commit 141feb2
Show file tree

Hide file tree

Showing 45 changed files with 74 additions and 48 deletions.
diff --git a/doc/docs/contributing.md b/doc/docs/contributing.md
@@ -103,12 +103,13 @@ os = library("oscillators.lib");
 no = library("noises.lib");
 pf = library("phaflangers.lib");
 pm = library("physmodels.lib");
+qu = library("quantizers.lib");
 rm = library("reducemaps.lib");
 re = library("reverbs.lib");
 ro = library("routes.lib");
-sp = library("spats.lib");
 si = library("signals.lib");
 so = library("soundfiles.lib");
+sp = library("spats.lib");
 sy = library("synths.lib");
 ve = library("vaeffects.lib");
 vl = library("version.lib");
@@ -147,3 +148,14 @@ Before preparing a pull-request, the new library must be carefully tested:
 import("all.lib");
 process = _;
 ```
+
+## Library deployment
+
+For GRAME maintainers:
+
+- update the library submodule in [faust](https://github.com/grame-cncm/faust), recompile and deploy WebAssembly libfaust in [fausteditor](https://github.com/grame-cncm/fausteditor), [faustplayground](https://github.com/grame-cncm/faustplayground) and [faustide](https://github.com/grame-cncm/faustide)
+- update the library submodule in [faustlive](https://github.com/grame-cncm/faustlive) 
+- update the library list in this [fausteditor](https://github.com/grame-cncm/fausteditor/blob/master/scripts/faustlive.js) page
+- update the library list in this [fausteide](https://github.com/grame-cncm/faustide/blob/master/src/documentation.ts) page
+- make an update PR for [vscode-faust](https://github.com/hellbent/vscode-faust) project
+
diff --git a/doc/docs/index.md b/doc/docs/index.md
@@ -38,6 +38,7 @@ This will give you access to all the Faust libraries through a series of environ
 * `no`: `noises.lib`
 * `pf`: `phaflangers.lib`
 * `pm`: `physmodels.lib`
+* `qu`: `quantizers.lib`
 * `rm`: `reducemaps.lib`
 * `re`: `reverbs.lib`
 * `ro`: `routes.lib`

diff --git a/doc/mkdocs.yml b/doc/mkdocs.yml
@@ -12,7 +12,7 @@ nav:
          - ' Copyright/License ':  about.md
     - Index: libs/index.md
     - Libraries:
-         - ' antialiased-nonlinearities ':  libs/aanl.md
+         - ' antialiased ':  libs/aanl.md
          - ' analyzers ':  libs/analyzers.md
          - ' basics ':  libs/basics.md
          - ' compressors ':  libs/compressors.md

diff --git a/doc/scripts/faustlib2md.awk b/doc/scripts/faustlib2md.awk
@@ -46,8 +46,6 @@ BEGIN {
 END {
 }
 
-
-
 /^\/\/====*$/ { }
 /^\/\/####*$/ { PRINTDOC = 0; }	# end documentation lines
 /^\/\/====*$/ { PRINTDOC = 0; }	# end function documentation

diff --git a/docs/404.html b/docs/404.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="/libs/aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="/libs/aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/about/index.html b/docs/about/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../libs/aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../libs/aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/community/index.html b/docs/community/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../libs/aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../libs/aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/contributing/index.html b/docs/contributing/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../libs/aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../libs/aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>
@@ -254,6 +254,10 @@
             <li class="nav-item" data-level="2"><a href="#testing-the-library" class="nav-link">Testing the library</a>
               <ul class="nav flex-column">
               </ul>
+            </li>
+            <li class="nav-item" data-level="2"><a href="#library-deployment" class="nav-link">Library deployment</a>
+              <ul class="nav flex-column">
+              </ul>
             </li>
               </ul>
             </li>
@@ -358,12 +362,13 @@ <h3 id="library-import">Library Import</h3>
 no = library(&quot;noises.lib&quot;);
 pf = library(&quot;phaflangers.lib&quot;);
 pm = library(&quot;physmodels.lib&quot;);
+qu = library(&quot;quantizers.lib&quot;);
 rm = library(&quot;reducemaps.lib&quot;);
 re = library(&quot;reverbs.lib&quot;);
 ro = library(&quot;routes.lib&quot;);
-sp = library(&quot;spats.lib&quot;);
 si = library(&quot;signals.lib&quot;);
 so = library(&quot;soundfiles.lib&quot;);
+sp = library(&quot;spats.lib&quot;);
 sy = library(&quot;synths.lib&quot;);
 ve = library(&quot;vaeffects.lib&quot;);
 vl = library(&quot;version.lib&quot;);
@@ -389,7 +394,16 @@ <h2 id="testing-the-library">Testing the library</h2>
 </ul>
 <pre><code>import(&quot;all.lib&quot;);
 process = _;
-</code></pre></div>
+</code></pre>
+<h2 id="library-deployment">Library deployment</h2>
+<p>For GRAME maintainers:</p>
+<ul>
+<li>update the library submodule in <a href="https://github.com/grame-cncm/faust">faust</a>, recompile and deploy WebAssembly libfaust in <a href="https://github.com/grame-cncm/fausteditor">fausteditor</a>, <a href="https://github.com/grame-cncm/faustplayground">faustplayground</a> and <a href="https://github.com/grame-cncm/faustide">faustide</a></li>
+<li>update the library submodule in <a href="https://github.com/grame-cncm/faustlive">faustlive</a> </li>
+<li>update the library list in this <a href="https://github.com/grame-cncm/fausteditor/blob/master/scripts/faustlive.js">fausteditor</a> page</li>
+<li>update the library list in this <a href="https://github.com/grame-cncm/faustide/blob/master/src/documentation.ts">fausteide</a> page</li>
+<li>make an update PR for <a href="https://github.com/hellbent/vscode-faust">vscode-faust</a> project</li>
+</ul></div>
             </div>
         </div>
 

diff --git a/docs/index.html b/docs/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="libs/aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="libs/aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>
@@ -270,6 +270,7 @@ <h2 id="using-the-faust-libraries">Using the Faust Libraries</h2>
 <li><code>no</code>: <code>noises.lib</code></li>
 <li><code>pf</code>: <code>phaflangers.lib</code></li>
 <li><code>pm</code>: <code>physmodels.lib</code></li>
+<li><code>qu</code>: <code>quantizers.lib</code></li>
 <li><code>rm</code>: <code>reducemaps.lib</code></li>
 <li><code>re</code>: <code>reverbs.lib</code></li>
 <li><code>ro</code>: <code>routes.lib</code></li>
@@ -386,5 +387,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
 
 <!--
 MkDocs version : 1.1.2
-Build Date UTC : 2021-05-23 11:52:24.546282+00:00
+Build Date UTC : 2021-05-23 18:47:39.288653+00:00
 -->
diff --git a/docs/libs/aanl/index.html b/docs/libs/aanl/index.html
@@ -8,7 +8,7 @@
 
 
         <link rel="shortcut icon" href="../../img/favicon.ico">
-        <title> antialiased-nonlinearities  - Faust Libraries</title>
+        <title> antialiased  - Faust Libraries</title>
         <link href="../../css/bootstrap.min.css" rel="stylesheet">
         <link href="../../css/font-awesome.min.css" rel="stylesheet">
         <link href="../../css/base.css" rel="stylesheet">
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="./" class="dropdown-item active"> antialiased-nonlinearities </a>
+    <a href="./" class="dropdown-item active"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/libs/analyzers/index.html b/docs/libs/analyzers/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/libs/basics/index.html b/docs/libs/basics/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/libs/compressors/index.html b/docs/libs/compressors/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/libs/delays/index.html b/docs/libs/delays/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/libs/demos/index.html b/docs/libs/demos/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/libs/dx7/index.html b/docs/libs/dx7/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/libs/envelopes/index.html b/docs/libs/envelopes/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/libs/fds/index.html b/docs/libs/fds/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/libs/filters/index.html b/docs/libs/filters/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/libs/hoa/index.html b/docs/libs/hoa/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/libs/index.html b/docs/libs/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/libs/interpolators/index.html b/docs/libs/interpolators/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/libs/maths/index.html b/docs/libs/maths/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/libs/mi/index.html b/docs/libs/mi/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/libs/misceffects/index.html b/docs/libs/misceffects/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/libs/noises/index.html b/docs/libs/noises/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/libs/oscillators/index.html b/docs/libs/oscillators/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/libs/phaflangers/index.html b/docs/libs/phaflangers/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/libs/physmodels/index.html b/docs/libs/physmodels/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/libs/quantizers/index.html b/docs/libs/quantizers/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/libs/reducemaps/index.html b/docs/libs/reducemaps/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/libs/reverbs/index.html b/docs/libs/reverbs/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/libs/routes/index.html b/docs/libs/routes/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>

diff --git a/docs/libs/signals/index.html b/docs/libs/signals/index.html
@@ -67,7 +67,7 @@
                                 <ul class="dropdown-menu">
 
 <li>
-    <a href="../aanl/" class="dropdown-item"> antialiased-nonlinearities </a>
+    <a href="../aanl/" class="dropdown-item"> antialiased </a>
 </li>
 
 <li>
-Original file line number
+Diff line change
@@ Expand Up / @@ -46,8 +46,6 @@ BEGIN { @@
     END {
     }
     /^\/\/====*$/ { }
     /^\/\/####*$/ { PRINTDOC = 0; }	# end documentation lines
     /^\/\/====*$/ { PRINTDOC = 0; }	# end function documentation
@@ Expand Down @@