Skip to content

Commit a124a9f

Browse files
committed
docs: update README
1 parent b4d76b3 commit a124a9f

1 file changed

Lines changed: 16 additions & 7 deletions

File tree

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -122,13 +122,22 @@ make -j8
122122
make run -j12
123123
```
124124

125-
- **Automatic behavior**: When you use `-j` (parallel mode), the **Makefile** automatically reduces verbosity to avoid chaotic interleaved output.
126-
- No fancy colors or status icon per file
127-
- Only essential messages and errors are shown
128-
- This prevents the terminal from becoming a mess when compiling dozens/hundreds of files at once.
129-
130125
- **Note**: Start with `-j4` or `-j8` and increase until you find the sweet spot for your machine (too high can cause memory thrashing if RAM is limited).
131-
- **On linux**: The verbose mode not deactivates automatically, so you can use `-s` to reduce output if needed.
126+
- **Output with `-j`**: Colors and per-file status are always shown. If output looks interleaved, use `--output-sync` (alias `-O`) to group each file's output together:
127+
128+
```bash
129+
make -j8 -Otarget # group output per compiled file (recommended)
130+
make -j8 -Oline # group output per line
131+
make -j8 -O # automatic grouping (default, usually same as -Otarget)
132+
```
133+
134+
> **Note**: `-O` / `--output-sync` requires GNU Make 4.0+. On macOS the default `make` is 3.81, use `gmake` from Homebrew instead.
135+
136+
- **Suppress all output**: Use `-s` (`--silent`) to disable verbose mode entirely:
137+
138+
```bash
139+
make -j8 -s
140+
```
132141

133142
## Customization
134143

@@ -334,7 +343,7 @@ MyProject/
334343
- **No rule to make target**: Verify source files exist in `src/` (or added folders)
335344
- **Sanitizers not working on Windows**: Disabled by design (partial support in **MinGW**)
336345
- **Double slashes in paths**: Usually harmless; caused by empty variables in some shells
337-
- **Colors broken in CI**: Parallel mode auto-disables fancy output
346+
- **Interleaved output with `-j`**: Use `make -j8 -O` to group output per file (requires GNU Make 4.0+)
338347
- **Too much output with `-j`**: Use `-jN` `-s` or redirect to log
339348
- **`clear` command not found (rare)**: On some Windows shells, fallback to `cls` happens automatically
340349

0 commit comments

Comments
 (0)