Skip to content

Add section for Nixpkgs in README #10

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

Open
myclevorname wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add section for Nixpkgs in README #10

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f16734b
Add Nix section
myclevorname Jul 4, 2024
50ebfb3
Update Nix section to indicate unstable channel
myclevorname Jul 4, 2024
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
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![Homebrew](https://img.shields.io/badge/dynamic/json.svg?url=https://api.github.com/repos/zmwangx/metadata/tags&label=homebrew&query=$[0].name&colorB=orange&maxAge=1800)](#homebrew)
[![crates.io](https://img.shields.io/crates/v/metadata.svg)](https://crates.io/crates/metadata)
[![Nix](https://repology.org/badge/version-for-repo/nix_unstable/metadata.svg?header=nixpkgs-unstable)](#nix)
[![Build status](https://github.com/zmwangx/metadata/workflows/test/badge.svg?branch=master)](https://github.com/zmwangx/metadata/actions)

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
Expand All @@ -12,6 +13,7 @@
- [Installation](#installation)
- [Homebrew](#homebrew)
- [Debian/Ubuntu](#debianubuntu)
- [NixOS/Nixpkgs]($nix)
- [Usage](#usage)
- [Performance](#performance)
- [Bugs](#bugs)
Expand Down Expand Up @@ -118,6 +120,17 @@ $ add-apt-repository ppa:zmwangx/metadata
$ apt update && apt install metadata
```

### Nix

On NixOS and any other Linux distro using Nix, `metadata` can be installed with Nix using the unstable channel:

```console
$ # Install it to your local profile:
$ nix-env -iA metadata
$ # As a Nix shell:
$ nix-shell -p metadata
```

### Building from source

**FFmpeg with development headers and the Rust toolchain are required.** FFmpeg 3.4 and later are supported.
Expand Down