Skip to content

Commit 7a24a32

Browse files
docs: fix README badge links and header layout
Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 5702092 commit 7a24a32

3 files changed

Lines changed: 156 additions & 104 deletions

File tree

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ core/multimux-core.pdb
4242
!.github/**
4343

4444
# Allow documentation & website
45-
!README.adoc
45+
!README.md
4646
!CHANGELOG.adoc
4747
!changelog-details/**
4848
!docs/**

README.adoc

Lines changed: 0 additions & 103 deletions
This file was deleted.

README.md

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
<a id="readme-top"></a>
2+
<div align="center">
3+
<a href="https://github.com/AMDphreak/multimux/graphs/contributors"><img src="https://img.shields.io/github/contributors/AMDphreak/multimux.svg?style=for-the-badge" alt="Contributors"></a>
4+
<a href="https://github.com/AMDphreak/multimux/network/members"><img src="https://img.shields.io/github/forks/AMDphreak/multimux.svg?style=for-the-badge" alt="Forks"></a>
5+
<a href="https://github.com/AMDphreak/multimux/stargazers"><img src="https://img.shields.io/github/stars/AMDphreak/multimux.svg?style=for-the-badge" alt="Stargazers"></a>
6+
<a href="https://github.com/AMDphreak/multimux/issues"><img src="https://img.shields.io/github/issues/AMDphreak/multimux.svg?style=for-the-badge" alt="Issues"></a>
7+
8+
<h1>multimux: Master Audio Mixdown Suite</h1>
9+
<p>A lightweight, cross-platform desktop app (Electron, SolidJS, TypeScript) to visually mix multiple discrete audio tracks from a recording into one master track while preserving video bit-for-bit (<code>-c:v copy</code>).</p>
10+
<p>
11+
<a href="https://github.com/AMDphreak/multimux/issues">Report Bug</a>
12+
&middot;
13+
<a href="https://github.com/AMDphreak/multimux/issues">Request Feature</a>
14+
</p>
15+
16+
<img src="resources/icon.png" alt="multimux Logo" width="128" height="128" />
17+
</div>
18+
19+
<details>
20+
<summary>Table of Contents</summary>
21+
<ol>
22+
<li>
23+
<a href="#about-the-project">About The Project</a>
24+
<ul>
25+
<li><a href="#built-with">Built With</a></li>
26+
</ul>
27+
</li>
28+
<li><a href="#getting-started">Getting Started</a></li>
29+
<li><a href="#usage">Usage</a></li>
30+
<li><a href="#explanation">Explanation</a></li>
31+
<li><a href="#changelog">Changelog</a></li>
32+
<li><a href="#contributing">Contributing</a></li>
33+
<li><a href="#contact">Contact</a></li>
34+
</ol>
35+
</details>
36+
37+
## About The Project
38+
39+
Screen-recording apps often capture mic, game, and chat on separate tracks. Players usually only hear track 1. multimux mixes selected tracks with FFmpeg `amix` while copying the video stream losslessly.
40+
41+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
42+
43+
### Built With
44+
45+
* **Desktop**[![Electron][Electron.com]][Electron-url]
46+
* [![SolidJS][SolidJS.dev]][SolidJS-url]
47+
* [![TypeScript][TypeScript.com]][TypeScript-url]
48+
* **Media**[![FFmpeg][FFmpeg.org]][FFmpeg-url] / FFprobe
49+
50+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
51+
52+
## Getting Started
53+
54+
### Prerequisites
55+
56+
* Windows 10/11, macOS, or Linux
57+
* `ffmpeg` and `ffprobe` on PATH
58+
* Node.js + pnpm
59+
60+
### Installation
61+
62+
```bash
63+
pnpm install
64+
pnpm run dev
65+
```
66+
67+
Use `F12` for the developer console if needed.
68+
69+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
70+
71+
## Usage
72+
73+
### First mixdown
74+
75+
1. Launch multimux.
76+
2. Drag a recording onto the **Inlet Port**.
77+
3. Toggle channels and adjust faders.
78+
4. Click **Mix & Mux Master**.
79+
5. Open the output from the completion overlay.
80+
81+
### Volume (dB)
82+
83+
* Drag faders up to `+6.0 dB` or down to mute.
84+
* Double-click a fader to reset to `0.0 dB`.
85+
86+
### Codecs
87+
88+
Under *Output Mux Specs*, choose **AAC** or **OPUS** and a bitrate (128k–320k).
89+
90+
### Silent video
91+
92+
Mute all channels, then mix — multimux uses FFmpeg `-an`.
93+
94+
### Build scripts
95+
96+
* `pnpm run dev` — hot-reload development
97+
* `pnpm run build` — compile assets
98+
* `pnpm run build:win` — Windows installer under `dist/`
99+
100+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
101+
102+
## Explanation
103+
104+
Unlike full re-encodes, multimux:
105+
106+
1. **Video stream copy (`-c:v copy`)** — lossless, fast container remux of video packets.
107+
2. **Audio mixdown (`amix`)** — decode selected tracks, apply volume, mix, encode one stereo master.
108+
109+
Example filter graph (CH1 at 1.0, CH3 at 1.5):
110+
111+
```text
112+
[0:a:0]volume=1.0[a0]; [0:a:2]volume=1.5[a2]; [a0][a2]amix=inputs=2:duration=longest:dropout_transition=0[a]
113+
```
114+
115+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
116+
117+
## Changelog
118+
119+
See [CHANGELOG.adoc](CHANGELOG.adoc).
120+
121+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
122+
123+
## Contributing
124+
125+
Fork, branch, and open a pull request.
126+
127+
### Top contributors
128+
129+
<a href="https://github.com/AMDphreak/multimux/graphs/contributors">
130+
<img src="https://contrib.rocks/image?repo=AMDphreak/multimux" alt="contributors" />
131+
</a>
132+
133+
For per-person profile links, prefer [all-contributors](https://allcontributors.org/).
134+
135+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
136+
137+
## Contact
138+
139+
Ryan Johnson — [@amdphreak](https://twitter.com/amdphreak)
140+
141+
Project Link: [https://github.com/AMDphreak/multimux](https://github.com/AMDphreak/multimux)
142+
143+
Site: [https://ryanjohnson.dev](https://ryanjohnson.dev)
144+
145+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
146+
147+
<!-- MARKDOWN LINKS & IMAGES -->
148+
[Electron.com]: https://img.shields.io/badge/Electron-191970?style=for-the-badge&logo=Electron&logoColor=white
149+
[Electron-url]: https://www.electronjs.org/
150+
[SolidJS.dev]: https://img.shields.io/badge/SolidJS-2C4F7C?style=for-the-badge&logo=solid&logoColor=white
151+
[SolidJS-url]: https://www.solidjs.com/
152+
[TypeScript.com]: https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white
153+
[TypeScript-url]: https://www.typescriptlang.org/
154+
[FFmpeg.org]: https://img.shields.io/badge/FFmpeg-007808?style=for-the-badge&logo=ffmpeg&logoColor=white
155+
[FFmpeg-url]: https://ffmpeg.org/

0 commit comments

Comments
 (0)