aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorDevine Lu Linvega <[email protected]>2019-04-04 11:47:29 +0900
committerDevine Lu Linvega <[email protected]>2019-04-04 11:47:29 +0900
commit98fb258fa813048d2012fae5cf801c10b304a86f (patch)
tree107dc692e15c5315fcdd28cc4cd20299891b9137
parentd39cb8b5a0e64a72d53326de26c7189a3be3801c (diff)
downloadOrca-98fb258fa813048d2012fae5cf801c10b304a86f.tar.gz
Orca-98fb258fa813048d2012fae5cf801c10b304a86f.zip
Improved docs
-rw-r--r--DESIGN.md53
-rw-r--r--README.md20
-rw-r--r--TUTORIAL.md4
-rw-r--r--examples/projects/pilot.orca12
-rw-r--r--examples/projects/sync.orca16
5 files changed, 28 insertions, 77 deletions
diff --git a/DESIGN.md b/DESIGN.md
deleted file mode 100644
index cc43977..0000000
--- a/DESIGN.md
+++ /dev/null
@@ -1,53 +0,0 @@
-# Design
-
-| Families | Glyphs
-| ---------- | -----------
-| Directions | N S E W Z
-| Math | A F I M R
-| Writers | G P X
-| Readers | O Q T
-| Jumpers | J Y
-| Timers | C D
-| Variables | K V
-| Misc | B H L U
-| Special | * # ; : =
-
-## Unstable Glyphs
-
-- `V` could be made into two special glyphs, one for reading and one for writing.
-
-## Attributes
-
-| ID# | Glyph | Rating | Stable | Outputs
-| --- | ----- | ------ | ------ | -------
-| 10 | A | +++++ | X | Any
-| 11 | B | ++++ | X | *
-| 12 | C | +++++ | X | Any
-| 13 | D | +++++ | X | *
-| 14 | E | +++++ | X |
-| 15 | F | +++++ | X | *
-| 16 | G | +++++ | X | Any - Multi - Unlocked
-| 17 | H | +++++ | X | Any
-| 18 | I | +++++ | X | Any
-| 19 | J | +++++ | X | Any
-| 20 | K | ++++ | |
-| 21 | L | ++ | |
-| 22 | M | +++++ | X | Any
-| 23 | N | +++++ | X |
-| 24 | O | +++++ | X | Any
-| 25 | P | +++++ | X | Any - Unlocked
-| 26 | Q | +++++ | X | Any - Multi
-| 27 | R | +++++ | X | Any
-| 28 | S | +++++ | X |
-| 29 | T | +++++ | X | Any
-| 30 | U | +++++ | X |
-| 31 | V | ++++ | | Any
-| 32 | W | +++++ | X |
-| 33 | X | +++++ | X | Any - Unlocked
-| 34 | Y | +++++ | X | Any
-| 35 | Z | +++ | X |
-| 36 | * | +++++ | X |
-| 37 | # | +++++ | X |
-| 39 | : | +++++ | X |
-| 38 | ; | +++++ | X |
-| 40 | = | +++++ | X |
diff --git a/README.md b/README.md
index 7130291..19e42b4 100644
--- a/README.md
+++ b/README.md
@@ -2,9 +2,11 @@
<img src='https://raw.githubusercontent.com/hundredrabbits/Orca/master/resources/logo.png' width="600"/>
-**Each letter of the alphabet is an operation**, lowercase letters operate on bang(`*`), uppercase letters operate each frame. Have a look at some project created with [#ORCΛ](https://twitter.com/hashtag/ORCΛ), or some [example files](https://github.com/hundredrabbits/Orca/tree/master/examples). Here's an [introduction video](https://www.youtube.com/watch?v=RaI_TuISSJE). You can see the [design notes](DESIGN.md) for specs and upcoming features. If you need some help, visit the [forum](https://llllllll.co/t/orca-live-coding-tool/17689), or the [chatroom](https://talk.lurk.org/channel/orca).
+**Each letter of the alphabet is an operation**, lowercase letters operate on bang, uppercase letters operate each frame.
-For a portable version of Orca, built entirely in C, visit [Orca-c](http://github.com/hundredrabbits/Orca-c).
+To get started, have a look at some projects created with [#ORCΛ](https://twitter.com/hashtag/ORCΛ), watch the [introduction video](https://www.youtube.com/watch?v=RaI_TuISSJE), or check out the [example files](https://github.com/hundredrabbits/Orca/tree/master/examples). If you need some help, visit the [forum](https://llllllll.co/t/orca-live-coding-tool/17689), or the [chatroom](https://talk.lurk.org/channel/orca). If you need Software specific help, check out the [tutorials](TUTORIAL.md).
+
+For a portable version of Orca, built entirely in C, visit [Orca-c](http://github.com/hundredrabbits/Orca-c). To quicky get started with Orca, have a look at the [Pilot tutorial](https://github.com/hundredrabbits/Orca/blob/master/TUTORIAL.md#pilot).
## Install & Run
@@ -176,6 +178,20 @@ Orca operates on a base of 36 increments. Operators using numeric values will ty
| ---------- | ---------- | ---------- | -----------|
| 49160 | None | 49161 | 49162
+# Operator Families
+
+| Families | Operators
+| ---------- | -----------
+| Directions | N S E W Z
+| Math | A F I M R
+| Writers | G P X
+| Readers | O Q T
+| Jumpers | J Y
+| Timers | C D
+| Variables | K V
+| Misc | B H L U
+| Special | * # ; : =
+
## Companion Applications
- [AIOI](https://github.com/MAKIO135/aioi), a companion to send complex OSC messages.
diff --git a/TUTORIAL.md b/TUTORIAL.md
index 6f6858b..352327d 100644
--- a/TUTORIAL.md
+++ b/TUTORIAL.md
@@ -56,6 +56,10 @@ To send [Midi notes](https://github.com/hundredrabbits/Orca#midi) to [Ableton Li
The midi instrument should begin receiving midi notes as soon as the Orca window is **in focus**.
+## Pilot
+
+[Pilot](https://github.com/hundredrabbits/Pilot) is a simple synth designed to work with Orca's UDP. It's designed to quickly get started with Orca. Remember that **Pilot uses UDP instead of MIDI**. Have a look at [pilot.orca](https://github.com/hundredrabbits/Orca/blob/master/examples/projects/pilot.orca) to see it in action.
+
# Patterns
Here's a collection of recurring patterns in the design of Orca machines.
diff --git a/examples/projects/pilot.orca b/examples/projects/pilot.orca
index b8c69cc..973909f 100644
--- a/examples/projects/pilot.orca
+++ b/examples/projects/pilot.orca
@@ -1,14 +1,14 @@
.........................................
.#.PILOT.#...............................
.........................................
+.2D6...2C4......gC4......................
+...i36..34TCAFE..04T0123.................
+.oV4....nVE......iV0.....................
.........................................
+.#.PLAY.#................................
.........................................
-.........................................
-.........................................
-.........................................
-.........................................
-.........................................
-.........................................
+.D23Kion.................................
+.*Y*;04E.................................
.........................................
.........................................
.........................................
diff --git a/examples/projects/sync.orca b/examples/projects/sync.orca
deleted file mode 100644
index 0f5cb81..0000000
--- a/examples/projects/sync.orca
+++ /dev/null
@@ -1,16 +0,0 @@
-.....................................................................
-.#.SYNC.#............................................................
-.....................................................................
-.C81C8......C81D8......C81C4......C81D4......C81C2......C81D2........
-.4.X4.......4.X........4.X0.......4.X*.......4.X0.......4.X*.........
-..#01234567...*..........01230123...*...*......01010101...*.*.*.*.#..
-.C82C8......C82D8......C82C4......C82D4......C82C2......C82D2........
-.4.X2.......4.X........4.X2.......4.X........4.X0.......4.X*.........
-..#00112677...*..........00112233...*..........00110011...*...*...#..
-.C84C8......C84D8......C84C4......C84D4......C84C2......C84D2........
-.4.X5.......4.X........4.X1.......4.X........4.X1.......4.X..........
-..#44445333..............00001333...*..........00001111...*.......#..
-.C88C8......C88D8......C88C4......C88D4......C88C2......C88D2........
-.4.X6.......4.X........4.X2.......4.X........4.X0.......4.X..........
-..#66666555..............22222111..............00000111...*.......#..
-..................................................................... \ No newline at end of file