Skip to content

Commit 8e7e947

Browse files
committed
Tau - update readme
Now includes basic instructions on how to run in prod and dev mode (not that this currently makes lots of sense outside of the context of Sonic Pi's app structure - but likely will soon)
1 parent 81faf1a commit 8e7e947

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

app/server/beam/tau/README.md

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

6+
# Development mode
7+
8+
To manually start the Tau server in development mode:
9+
10+
1. Set the `MIX_ENV` environment variable to `dev`
11+
2. Run the `setup.dev` mix action
12+
3. Start mix with the `--no-halt` flag.
13+
14+
```batchfile
15+
rem Windows
16+
set MIX_ENV=dev
17+
mix setup.dev
18+
mix run --no-halt
19+
```
20+
21+
```shell
22+
# macOS/Linux
23+
MIX_ENV=dev
24+
mix setup.dev
25+
mix run --no-halt
26+
```
27+
28+
Note, you will need to connect the browser to localhost on the port which is printed to the log files.
29+
30+
Also, note, that unless you compile and provide the shared libraries for the MIDI and Link NIFs, this functionality will not be available.
31+
32+
33+
# Production mode
34+
35+
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:
36+
37+
38+
```batchfile
39+
rem Windows Command Prompt
40+
set MIX_ENV=prod
41+
mix tau.release
42+
_build\prod\rel\tau\bin\tau start > NUL 2>&1
43+
```
44+
45+
```shell
46+
# macOS/Linux Terminal Prompt
47+
MIX_ENV=dev
48+
mix tau.release
49+
_build/prod/rel/tau/bin/tau start > /dev/null 2>&1
50+
```
51+
52+
53+
54+
655

0 commit comments

Comments
 (0)