Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ideoforms committed Nov 7, 2023
1 parent fe451fa commit 52c517f
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
7 changes: 5 additions & 2 deletions docs/installation/macos/easy.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ Visual Studio Code will launch into some activity, in which it is installing nec

When the setup is complete, the button in the top right should change to say `.venv (Python 3.12.x)`.

!!! info
New notebooks created within this workspace can share the same Python virtual environment, and will find it automatically.

You're now all set to start writing code!

## 7. Start writing code
Expand All @@ -70,7 +73,7 @@ To run the cell, press `^↵` (control-enter). You should see "Hello, world" app

!!! info "Keyboard shortcuts"
- Navigate between cells with the arrow keys
- Use `enter` to begin editing a cell, and `escape` to end editing and move to select mode
- Press `enter` to begin editing a cell, and `escape` to end editing and move to select mode
- In select mode, use `b` to add a cell after the current cell, and `a` to add a cell before it
- To evaluate a cell and move on to the next cell, use `⇧↵` (shift-enter)

Expand All @@ -84,7 +87,7 @@ from signalflow import *

Run the cell with `^↵`. This imports all of the SignalFlow commands and classes.

Create a new cell (`b`), and in the new cell, run:
Create a new cell by pressing `b`, and in the new cell, run:

```python
graph = AudioGraph()
Expand Down
8 changes: 5 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
site_name: SignalFlow
site_name: SignalFlow: Python sound synthesis and DSP
site_description: SignalFlow is a sound synthesis framework designed for exploring complex sonic ideas.
repo_name: ideoforms/signalflow
repo_url: https://github.com/ideoforms/signalflow

theme:
name: material
palette:
- primary: pink
features:
- content.code.copy

repo_name: ideoforms/signalflow
repo_url: https://github.com/ideoforms/signalflow

extra:
social:
Expand Down

0 comments on commit 52c517f

Please sign in to comment.