Skip to content

Commit

Permalink
Deployed 21be90b with MkDocs version: 1.5.3
Browse files Browse the repository at this point in the history
  • Loading branch information
ideoforms committed Nov 7, 2023
1 parent 1144e79 commit 8737545
Show file tree
Hide file tree
Showing 8 changed files with 27 additions and 10 deletions.
4 changes: 2 additions & 2 deletions examples/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1222,8 +1222,8 @@


<h1 id="examples">Examples</h1>
<p>For various code examples using SignalFlow, see <code>examples/python</code> in GitHub:</p>
<p><a href="https://github.com/ideoforms/signalflow/tree/master/examples/python">https://github.com/ideoforms/signalflow/tree/master/examples/python</a></p>
<p>For various code examples using SignalFlow, see <code>examples</code> in GitHub:</p>
<p><a href="https://github.com/ideoforms/signalflow/tree/master/examples">https://github.com/ideoforms/signalflow/tree/master/examples</a></p>



Expand Down
2 changes: 1 addition & 1 deletion getting-started/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1337,7 +1337,7 @@ <h3 id="macos">macOS</h3>
<p>If you're new to Python or getting started from scratch: </p>
<p><a class="md-button" href="../installation/macos/easy/">macOS: Install SignalFlow with Visual Studio Code</a> </p>
<h2 id="examples">Examples</h2>
<p><a href="https://github.com/ideoforms/signalflow/tree/master/examples/python">Several example scripts</a> are included within the repo, covering simple control and modulation, FM synthesis, sample granulation, MIDI control, chaotic functions, etc.</p>
<p><a href="https://github.com/ideoforms/signalflow/tree/master/examples">Several example scripts</a> are included within the repo, covering simple control and modulation, FM synthesis, sample granulation, MIDI control, chaotic functions, etc.</p>



Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1348,7 +1348,7 @@ <h2 id="example">Example</h2>
<h2 id="documentation">Documentation</h2>
<ul>
<li><a href="getting-started/">Installation</a></li>
<li><a href="http://github.com/ideoforms/signalflow/tree/master/examples/python">Example code</a></li>
<li><a href="http://github.com/ideoforms/signalflow/tree/master/examples">Example code</a></li>
</ul>


Expand Down
2 changes: 1 addition & 1 deletion installation/linux/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1316,7 +1316,7 @@ <h2 id="installation">Installation</h2>
</code></pre></div>
<p>For more detailed installation information, including Windows install and compilation from source, see the <a href="https://github.com/ideoforms/signalflow">README</a>.</p>
<h2 id="examples">Examples</h2>
<p><a href="https://github.com/ideoforms/signalflow/tree/master/examples/python">Several example scripts</a> are included within the repo, covering simple control and modulation, FM synthesis, sample granulation, MIDI control, chaotic functions, etc.</p>
<p><a href="https://github.com/ideoforms/signalflow/tree/master/examples">Several example scripts</a> are included within the repo, covering simple control and modulation, FM synthesis, sample granulation, MIDI control, chaotic functions, etc.</p>



Expand Down
2 changes: 1 addition & 1 deletion installation/macos/command-line/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1338,7 +1338,7 @@ <h2 id="3-line-test">3. Line test</h2>
<div class="highlight"><pre><span></span><code>signalflow test
</code></pre></div>
<h2 id="examples">Examples</h2>
<p><a href="https://github.com/ideoforms/signalflow/tree/master/examples/python">Several example scripts</a> are included within the repo, covering simple control and modulation, FM synthesis, sample granulation, MIDI control, chaotic functions, etc.</p>
<p><a href="https://github.com/ideoforms/signalflow/tree/master/examples">Several example scripts</a> are included within the repo, covering simple control and modulation, FM synthesis, sample granulation, MIDI control, chaotic functions, etc.</p>



Expand Down
23 changes: 20 additions & 3 deletions installation/macos/easy/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1377,17 +1377,31 @@

<h1 id="signalflow-easy-install-for-macos">SignalFlow: Easy install for macOS</h1>
<p>The simplest way to start exploring SignalFlow is with the free <a href="https://code.visualstudio.com/">Visual Studio Code</a> editor. Visual Studio Code can edit interactive "Jupyter" notebooks, which allow you to run and modify blocks of Python code in real-time, which is a great way to experiment live with audio synthesis.</p>
<p>You'll only need to do this installation process once. Once setup, experimenting with SignalFlow is as simple as opening Visual Studio Code. </p>
<h2 id="1-install-python">1. Install Python</h2>
<p>Download and install the latest version of Python (currently 3.12).</p>
<p><a class="md-button" href="https://www.python.org/downloads/">Download Python</a></p>
<h2 id="2-download-and-install-visual-studio-code">2. Download and install Visual Studio Code</h2>
<p>Download and install the latest version of Visual Studio Code.</p>
<p><a class="md-button" href="https://code.visualstudio.com/Download">Download Visual Studio Code</a></p>
<p>Once installed, open <code>Applications</code> and run <code>Visual Studio Code</code>.</p>
<h2 id="3-create-a-new-visual-studio-code-workspace">3. Create a new Visual Studio Code workspace</h2>
<p>Open Visual Studio Code, select <code>File → Open Folder...</code>, select <code>New Folder</code>, and create a new folder that will contain all your new SignalFlow project.</p>
<p>In Visual Studio code, create a new folder to contain your new SignalFlow project:</p>
<ul>
<li>Select <code>File → Open Folder...</code></li>
<li>Select <code>New Folder</code>, and pick a name for your new project folder</li>
</ul>
<div class="admonition info">
<p class="admonition-title">Where to put your workspace</p>
<p>You can store your project workspace anywhere on your drive. The workspace can hold multiple notebooks, audio files, etc.</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Trusted workspaces</p>
<p>If Visual Studio asks "Do you trust the authors of the files in this folder?", select "Yes, I trust the authors". This is a security mechanism to protect you against untrusted third-party code.</p>
</div>
<h2 id="4-install-the-python-and-jupyter-extensions">4. Install the Python and Jupyter extensions</h2>
<p>Visual Studio Code requires some extensions to be installed to handle Python and Jupyter files.</p>
<p>In Visual Studio Code, select the <code>Extensions</code> icon from in the far-left column (or press <code>⇧⌘X</code>), and install the <code>Python</code> and <code>Jupyter</code> extensions by searching their names. These are needed to modify Jupyter notebooks in real-time.</p>
<p>Visual Studio Code requires extensions to be installed to handle Python and Jupyter files.</p>
<p>In Visual Studio Code, select the <code>Extensions</code> icon from in the far-left column (or press <code>⇧⌘X</code>), and install the <code>Python</code> and <code>Jupyter</code> extensions by searching for their names and clicking "Install" on each.</p>
<p>Once installation has finished, close the <code>Extensions</code> tab.</p>
<h2 id="5-create-a-notebook-in-visual-studio-code">5. Create a notebook in Visual Studio Code</h2>
<p>Select <code>File → New File...</code> (<code>^⌥⌘N</code>), and select <code>Jupyter Notebook</code>. You should see the screen layout change to display an empty black text block (in Jupyter parlance, a "cell"). </p>
Expand Down Expand Up @@ -1430,6 +1444,9 @@ <h2 id="8-start-a-signalflow-session">8. Start a SignalFlow session</h2>
<span class="n">sine</span><span class="o">.</span><span class="n">play</span><span class="p">()</span>
</code></pre></div>
<p>This will create a sine oscillator, attenuate it, and play it from the system. Hopefully you should now hear a tone playing from your speaker or headphones.</p>
<p>To stop the playback, create a new cell and run:</p>
<div class="highlight"><pre><span></span><code><span class="n">sine</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span>
</code></pre></div>



Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

Binary file modified sitemap.xml.gz
Binary file not shown.

0 comments on commit 8737545

Please sign in to comment.