Merge pull request #239 from jweather/docs

docs and Ctrl-G
sonic-pi-net · Nov 21, 2014 · 51e129c · 51e129c
2 parents 7ed784b + 66ad088
commit 51e129c
Show file tree

Hide file tree

Showing 16 changed files with 25 additions and 17 deletions.
diff --git a/app/gui/qt/mainwindow.cpp b/app/gui/qt/mainwindow.cpp
@@ -613,7 +613,7 @@ void MainWindow::initPrefsWindow() {
   addKeyBinding(settings, QsciCommand::VerticalCentreCaret, Qt::Key_L | SPi_CTRL);
 
   addKeyBinding(settings, QsciCommand::Cancel, Qt::Key_Escape);
-  addKeyBinding(settings, QsciCommand::Cancel, Qt::Key_G | SPi_CTRL);
+  addOtherKeyBinding(settings, QsciCommand::Cancel, Qt::Key_G | SPi_CTRL);
 
   // tab return
   addKeyBinding(settings, QsciCommand::Newline, Qt::Key_Return);

diff --git a/etc/doc/tutorial/04-Randomisation.md b/etc/doc/tutorial/04-Randomisation.md
@@ -186,7 +186,7 @@ dice - perhaps even a 120 sided dice!
 
 ## one_in
 
-Finally you may wish to emulate throwing a the top score of a dice such
+Finally you may wish to emulate throwing the top score of a dice such
 as a 6 in a standard dice. `one_in` therefore returns true with a
 probability of one in the number of sides on the dice. Therefore
 `one_in(6)` will return true with a probability of 1 in 6 or false

diff --git a/...c/tutorial/04.7-Thread-Synchronisation.md → ...c/tutorial/05.7-Thread-Synchronisation.md b/...c/tutorial/04.7-Thread-Synchronisation.md → ...c/tutorial/05.7-Thread-Synchronisation.md
diff --git a/etc/doc/tutorial/06-FX.md b/etc/doc/tutorial/06-FX.md
@@ -9,7 +9,7 @@ Sonic Pi provides a very simple yet powerful way of adding FX. It even
 allows you to chain them (so you can pass your sounds through
 distortion, then echo and then reverb) and also control each individual
 FX unit with parameters (in a similar way to giving params to synths and
-samples. You can even modify the paramters to the FX whilst it's still
+samples). You can even modify the parameters to the FX whilst it's still
 running. So, for example, you could increase the reverb on your bass
 throughout the track...
 

diff --git a/etc/doc/tutorial/06.1-Adding-FX.md b/etc/doc/tutorial/06.1-Adding-FX.md
@@ -3,7 +3,7 @@
 In this section we'll look at a couple of FX, reverb and echo. We'll see
 how to use them, how to control their parameters and how to chain them. 
 
-Sonic Pi's FX system uses blocks. So if you haven't read section 4.1 you
+Sonic Pi's FX system uses blocks. So if you haven't read section 5.1 you
 might want to take a quick read and then head back.
 
 ## Reverb

diff --git a/etc/doc/tutorial/06.3-FX-in-Practice.md → etc/doc/tutorial/06.2-FX-in-Practice.md b/etc/doc/tutorial/06.3-FX-in-Practice.md → etc/doc/tutorial/06.2-FX-in-Practice.md
@@ -1,6 +1,6 @@
 # FX in Practice
 
-Also they look simple on the outside, FX are actually quite complex
+Although they look simple on the outside, FX are actually quite complex
 beasts internally. Their simplicity often means that people overuse them
 in their pieces. This may be fine if you have a powerful machine, but if
 like me you use a Raspberry Pi to jam with, you need to be careful about

diff --git a/etc/doc/tutorial/07.3-Sliding-Parameters.md b/etc/doc/tutorial/07.3-Sliding-Parameters.md
@@ -19,7 +19,7 @@ sleep 3
 control s, note: 72
 ```
 
-Here, hear the synth pitch changing immediately on each
+Here, you can hear the synth pitch changing immediately on each
 control. However, we might want the pitch to slide between changes. As
 we're controlling the `note:` parameter, to add slide, we need to set
 the `note_slide` parameter:

diff --git a/etc/doc/tutorial/08.1-Chords.md → etc/doc/tutorial/08.2-Chords.md b/etc/doc/tutorial/08.1-Chords.md → etc/doc/tutorial/08.2-Chords.md
diff --git a/etc/doc/tutorial/08.2-Scales.md → etc/doc/tutorial/08.3-Scales.md b/etc/doc/tutorial/08.2-Scales.md → etc/doc/tutorial/08.3-Scales.md
diff --git a/etc/doc/tutorial/09-Live-Coding.md b/etc/doc/tutorial/09-Live-Coding.md
@@ -10,4 +10,4 @@ can take Sonic Pi on stage and gig with it.
 In this section we'll cover the fundamentals of turning your static code
 compositions into dynamic performances.
 
-Hold onto your seats...
+Hold on to your seats...
diff --git a/etc/doc/tutorial/09.1-Live-Coding-Fundamentals.md b/etc/doc/tutorial/09.1-Live-Coding-Fundamentals.md
@@ -48,7 +48,7 @@ allow one thread for each name. Also, the sound changed because we
 `:looper` thread looped round again it simply called the new definition.
 
 Try changing it again, change the note, change the sleep time. How about
-adding a `use_synth` statement. For example, change it to:
+adding a `use_synth` statement? For example, change it to:
 
 ```
 define :my_loop do
@@ -58,7 +58,7 @@ define :my_loop do
 end
 ```
 
-Now it's sounding pretty interesting, but we can spice it up further. Instead of playing the same note again and again, try playing a chords
+Now it's sounding pretty interesting, but we can spice it up further. Instead of playing the same note again and again, try playing a chord:
 
 ```
 define :my_loop do
@@ -78,7 +78,7 @@ define :my_loop do
 end
 ```
 
-How about about using a random cutoff value:
+Or using a random cutoff value:
 
 ```
 define :my_loop do

diff --git a/etc/doc/tutorial/09.2-Live-Loops.md b/etc/doc/tutorial/09.2-Live-Loops.md
@@ -47,7 +47,7 @@ end
 
 Hit run again.
 
-Add some drums
+Add some drums:
 
 ```
 live_loop :foo do

diff --git a/etc/doc/tutorial/09.3-Multiple-Live-Loops.md b/etc/doc/tutorial/09.3-Multiple-Live-Loops.md
@@ -59,7 +59,7 @@ end
 ```
 
 Let's see if we can fix the timing and sync without stopping it. First,
-let's Fix the `:foo` loop to me the sleep a factor of 1 - something like
+let's fix the `:foo` loop to make the sleep a factor of 1 - something like
 `0.5` will do:
 
 ```

diff --git a/etc/doc/tutorial/10.1-Using-Shortcuts.md b/etc/doc/tutorial/10.1-Using-Shortcuts.md
@@ -66,7 +66,7 @@ mouse or the arrow keys on your keyboard.
 You can move to the beginning of the line with `C-a`, the end of the
 line with `C-e`, up a line with `C-p`, down a line with `C-n`, forward a
 character with `C-f`, and back a character with `C-b`. You can even
-delete all the charachters from the cursor to the end of the line with
+delete all the characters from the cursor to the end of the line with
 `C-k`.
 
 ## Tidy Code
@@ -79,5 +79,5 @@ To toggle the help system you can press `M-i`. However, a much more
 useful shortcut to know is `C-i` which will look up the word underneath
 the cursor and display the docs if it finds anything. Instant help!
 
-For a full list take a look at section 1.3 Shortcut Cheatsheet.
+For a full list take a look at section 10.2 Shortcut Cheatsheet.
 
diff --git a/etc/doc/tutorial/10.2-Shortcut-Cheatsheet.md b/etc/doc/tutorial/10.2-Shortcut-Cheatsheet.md
@@ -1,7 +1,7 @@
 # Shortcut Cheatsheet
 
 The following is a summary of the main shortcuts available within Sonic
-Pi. Please see Section 1.2 for motivation and background.
+Pi. Please see Section 10.1 for motivation and background.
 
 ## Conventions
 
@@ -15,8 +15,8 @@ Windows and Linux and *cmd* on Mac):
 
 ## Main Application Manipulation
 
-* `C-r` - Run code
-* `C-s` - Stop code
+* `M-r` - Run code
+* `M-s` - Stop code
 * `M-i` - Toggle Help System
 * `M-p` - Toggle Preferences
 

diff --git a/etc/doc/tutorial/10.3-Sharing.md b/etc/doc/tutorial/10.3-Sharing.md
@@ -30,6 +30,14 @@ your piece, other users can comment and discuss your work. I also
 recommend placing a link to a [Gist](https://gist.github.com) of your
 code in the track description.
 
+To record your work, hit the `Rec` button in the toolbar, and
+recording starts immediately.  Hit `Run` to start your code running if
+it isn't already in progress.  When you're done recording, press the
+flashing `Rec` button again, and you'll be prompted to enter a
+filename.  The recording will be saved as a WAV file, which can be
+edited and converted to MP3 by any number of free programs (try
+Audacity for instance).
+
 ## Hope
 
 I encourage you to share you work and really hope that we'll all teach