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
3939 make mac-ub
4040 ```
4141
42−This should create a `chuck` executable in `chuck/src`.
42+This should build a `chuck` executable in `chuck/src`.
4343
4444 ### Linux
45−Dependencies: gcc, g++, make, bison, flex, libsndfile, ALSA, PulseAudio (for linux-pulse builds), JACK (for linux-jack builds)
45+Dependencies: gcc, g++, make, bison, flex, libsndfile, ALSA (for linux-alsa builds), PulseAudio (for linux-pulse builds), JACK (for linux-jack builds)
4646
4747 To set up a build environment for **chuck** on Debian or Ubuntu:
4848 ```
4949 sudo apt install build-essential bison flex libsndfile1-dev \
5050 libasound2-dev libpulse-dev libjack-jackd2-dev
5151 ```
52−For other Linux distributions, the setup should be similar although the package install tools and package names may be slightly different.
52+For 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._)
5353
54−
55−To build, navigate to the `chuck/src` directory:
54+To build **chuck** (with all suppported drivers: ALSA, PulseAudio, JACK), navigate to the `chuck/src` directory and run `make`:
5655 ```
5756 cd chuck/src
57+make linux-alsa linux-pulse linux-jack
5858 ```
5959
60−To build chuck with all supported drivers: ALSA, PulseAudio, and JACK:
60+To 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:
6161 ```
62−make linux-alsa linux-pulse linux-jack
62+make linux-alsa linux-pulse
6363 ```
6464
65−To build chuck that specifically supports ALSA, PulseAudio, or JACK (or any combination thereof), run `make` with desired driver(s).
66−For example, to build for ALSA/JACK:
65+Or, to build for ALSA only:
6766 ```
68−make linux-alsa linux-jack
67+make linux-alsa
6968 ```
7069
71−This should create a `chuck` executable in `chuck/src`.
70+This build process should build a `chuck` executable in `chuck/src`.
7271
7372 ### Windows
7473 To 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
8786
8887 ## ChucK Community
8988 Join 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