Skip to content

Commit 311244f

Browse files
committed
README - tidy up markdown syntax
1 parent b95ebde commit 311244f

File tree

2 files changed

+21
-26
lines changed

2 files changed

+21
-26
lines changed

app/server/beam/README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
## Use of Erlang in Sonic Pi.
1+
# Use of Erlang in Sonic Pi
22

3-
*Copied from Sam Aarons post in in-thread.sonic-pi.net about the usage of
3+
*Copied from Sam Aarons post in <https://in-thread.sonic-pi.net> about the usage of
44
Erlang in Sonic Pi.*
55

66
Sonic Pi works by scheduling all events ahead of time.
@@ -10,7 +10,7 @@ This was made possible because SuperCollider, the synth engine that Sonic Pi
1010
uses, is able to receive timestamped messages ahead of time, and schedule them
1111
internally to execute at exactly the right time. This is made possible via OSC
1212
bundles. For a (probably way too detailed) treaty of this take a look at this
13-
paper: https://www.cs.kent.ac.uk/people/staff/dao7/publ/farm14-aaron.pdf
13+
paper: <https://www.cs.kent.ac.uk/people/staff/dao7/publ/farm14-aaron.pdf>
1414

1515
With the release of v3, Sonic Pi gained the ability to talk OSC and MIDI. It’s
1616
clearly important that these OSC and MIDI events do not happen with the code
@@ -49,36 +49,38 @@ in time with SuperCollider then we have tools to convert OSC to MIDI.
4949

5050
I can totally imagine other similar tools converting OSC to other useful formats
5151
which will also allow us to take advantage of the Erlang scheduler in the future.
52-
5352
*End of post copy*
5453

55-
### Bundle commands
56-
```
54+
## Bundle commands
55+
56+
```text
5757
["/send_after", Host, Port | Cmd]
5858
["/send_after_tagged", Tag, Host, Port | Cmd]
5959
```
60-
Both commands send the OSC message <Cmd> to <Host,Port> at the time in the
60+
61+
Both commands send the OSC message `Cmd` to `Host,Port` at the time in the
6162
bundle header
6263

63-
### Immediate Commands
64-
```
64+
## Immediate Commands
65+
66+
```text
6567
["/flush", <Tag>]
6668
```
6769

68-
### Tagged send_after's
70+
## Tagged send_after's
6971

7072
A Tag can be associated with a send-after command.
71-
If no tag is explicitly named the tag called "default" is assumed.<br/>
73+
If no tag is explicitly named the tag called "default" is assumed.
7274
`["/flush", Tag]` cancels all send-after commands which have not yet been
7375
issued.
7476

75-
#### Examples:
77+
### Examples
7678

77-
`["/flush", "default"]`<br/>
79+
`["/flush", "default"]`
7880
cancels all send-after requests that were scheduled with a
7981
`["/send_after", Host, Port, ...]` bundle.
8082

81-
`["/flush", "drums"]`<br/>
83+
`["/flush", "drums"]`
8284
cancels all send-after request that were scheduled with a
8385
`["/send_after_tagged,"drums", Host, Port, ...]` bundle
8486

@@ -97,6 +99,6 @@ proceed.
9799

98100
## Information for developers
99101

100-
* [Erlang](http://www.erlang.org/)
101-
* [Time and Time Correction in Erlang](http://erlang.org/doc/apps/erts/time_correction.html)
102-
* [Learn You Some Erlang for great good!](https://learnyousomeerlang.com/)
102+
* [Erlang](http://www.erlang.org/)
103+
* [Time and Time Correction in Erlang](http://erlang.org/doc/apps/erts/time_correction.html)
104+
* [Learn You Some Erlang for great good!](https://learnyousomeerlang.com/)

app/server/beam/tau/README.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Erlang/Elixir IO Server with C++ NIFs for MIDI and Link plus support for
44
future Rust NIFs.
55

6-
# Development mode
6+
## Development mode
77

88
To manually start the Tau server in development mode:
99

@@ -29,12 +29,10 @@ Note, you will need to connect the browser to localhost on the port which is pri
2929

3030
Also, note, that unless you compile and provide the shared libraries for the MIDI and Link NIFs, this functionality will not be available.
3131

32-
33-
# Production mode
32+
## Production mode
3433

3534
When Tau is packaged into a Sonic Pi release, it is first turned into a mix release which is then started with `MIX_ENV=prod`. You can manually achieve this with the following:
3635

37-
3836
```batchfile
3937
rem Windows Command Prompt
4038
set MIX_ENV=prod
@@ -48,8 +46,3 @@ MIX_ENV=dev
4846
mix tau.release
4947
_build/prod/rel/tau/bin/tau start > /dev/null 2>&1
5048
```
51-
52-
53-
54-
55-

0 commit comments

Comments
 (0)