History

Update README.md streamline linux instructions; happy chucking

Ge Wang committed 3 years ago

Commit 495cbbf1 parent 6cc09601 file · +13 −11Browse files

Unified · Split

README.md+13−11
@@ -39,36 +39,35 @@ OR to build a universal binary (intel + apple sillicon): · 38 unmodified lines
39make mac-ub39make mac-ub
40```40```
41 41
42This should create a `chuck` executable in `chuck/src`.42This should build a `chuck` executable in `chuck/src`.
43 43
44### Linux44### Linux
45Dependencies: gcc, g++, make, bison, flex, libsndfile, ALSA, PulseAudio (for linux-pulse builds), JACK (for linux-jack builds)45Dependencies: gcc, g++, make, bison, flex, libsndfile, ALSA (for linux-alsa builds), PulseAudio (for linux-pulse builds), JACK (for linux-jack builds)
46 46
47To set up a build environment for **chuck** on Debian or Ubuntu:47To set up a build environment for **chuck** on Debian or Ubuntu:
48```48```
49sudo apt install build-essential bison flex libsndfile1-dev \49sudo apt install build-essential bison flex libsndfile1-dev \
50 libasound2-dev libpulse-dev libjack-jackd2-dev50 libasound2-dev libpulse-dev libjack-jackd2-dev
51```51```
52For other Linux distributions, the setup should be similar although the package install tools and package names may be slightly different.52For other Linux distributions, the setup should be similar although the package install tools and package names may be slightly different. (_NOTE: setups that do not need JACK or PulseAudio can omit either or both of these packages. ALSA is needed for MIDI support on Linux._)
53 53
54 54To build **chuck** (with all suppported drivers: ALSA, PulseAudio, JACK), navigate to the `chuck/src` directory and run `make`:
55To build, navigate to the `chuck/src` directory:
56```55```
57cd chuck/src56cd chuck/src
57make linux-alsa linux-pulse linux-jack
58```58```
59 59
60To build chuck with all supported drivers: ALSA, PulseAudio, and JACK:60To build **chuck** with support for a subset of ALSA, PulseAudio, or JACK, run `make` with the desired driver(s). For example, to build for ALSA and PulseAudio only:
61```61```
62make linux-alsa linux-pulse linux-jack62make linux-alsa linux-pulse
63```63```
64 64
65To build chuck that specifically supports ALSA, PulseAudio, or JACK (or any combination thereof), run `make` with desired driver(s).65Or, to build for ALSA only:
66For example, to build for ALSA/JACK:
67```66```
68make linux-alsa linux-jack67make linux-alsa
69```68```
70 69
71This should create a `chuck` executable in `chuck/src`.70This build process should build a `chuck` executable in `chuck/src`.
72 71
73### Windows72### Windows
74To build chuck using Visual Studio (2019 or later recommended), navigate to `chuck\src\visual-studio`, open `chuck.sln`, and build.73To build chuck using Visual Studio (2019 or later recommended), navigate to `chuck\src\visual-studio`, open `chuck.sln`, and build.
@@ -87,3 +86,6 @@ Non-source code documents (papers, logos, soundbites, comics) have been migrated · 12 unmodified lines
87 86
88## ChucK Community87## ChucK Community
89Join us! [ChucK Community Discord](https://discord.gg/ENr3nurrx8) | [ChucK-users Mailing list](https://lists.cs.princeton.edu/mailman/listinfo/chuck-users)88Join us! [ChucK Community Discord](https://discord.gg/ENr3nurrx8) | [ChucK-users Mailing list](https://lists.cs.princeton.edu/mailman/listinfo/chuck-users)
89
90
91_Happy ChucKing!_

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t