Skip to content

Fix README installation structure and clarity #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cwage merged 1 commit into from
Aug 9, 2025
Merged

Fix README installation structure and clarity #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 13 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,40 +20,39 @@ A lightweight system tray application for Linux that provides per-application vo

Download the latest `.deb` package from the [releases page](https://github.com/cwage/volmix/releases):

```bash
# Download the package for your architecture (replace <version> with latest release version)
wget https://github.com/cwage/volmix/releases/latest/download/volmix_<version>_amd64.deb

# Install the package (replace <version> with the actual version downloaded)
sudo dpkg -i volmix_<version>_amd64.deb

# Install any missing dependencies
sudo apt-get install -f
```
1. Go to the [releases page](https://github.com/cwage/volmix/releases)
2. Download the `.deb` file for your architecture:
- `volmix_*_amd64.deb` for most desktop/laptop systems
- `volmix_*_arm64.deb` for ARM-based systems (Raspberry Pi 4+, etc.)
3. Install the package:
```bash
sudo dpkg -i volmix_*.deb
sudo apt-get install -f # Install any missing dependencies
```
Comment on lines +29 to +31
Copy link

Copilot AI Aug 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using a wildcard pattern volmix_*.deb could be problematic if multiple .deb files exist in the directory. Consider providing a more specific example like sudo dpkg -i volmix_1.0.0_amd64.deb or instructing users to replace with the actual filename.

Suggested change
sudo dpkg -i volmix_*.deb
sudo apt-get install -f # Install any missing dependencies
```
sudo dpkg -i volmix_1.0.0_amd64.deb
sudo apt-get install -f # Install any missing dependencies

Replace volmix_1.0.0_amd64.deb with the actual filename you downloaded.

Copilot uses AI. Check for mistakes.

**Available Architectures:**
- `amd64` (x86_64) - Most desktop/laptop systems
- `arm64` (AArch64) - ARM-based systems, Raspberry Pi 4+

### Option 2: Build from Source

## Dependencies
#### Build Dependencies

### Required Libraries
Required libraries:
- `libpulse-dev` - PulseAudio client library
- `libgtk-3-dev` - GTK3 GUI framework
- `libglib2.0-dev` - GLib utilities
- `pkg-config` - Package configuration tool
- `build-essential` - Compilation tools
- `autotools-dev autoconf automake` - Build system

### Installation on Debian/Ubuntu
Install build dependencies on Debian/Ubuntu:
```bash
sudo apt install build-essential autotools-dev autoconf automake \
libpulse-dev libgtk-3-dev libglib2.0-dev pkg-config
```

## Building
#### Building Steps

1. **Generate build configuration:**
```bash
Expand Down