From 6363c4955b2c9d7d537a263261aaee004c1fdf90 Mon Sep 17 00:00:00 2001 From: Raphael Das Gupta Date: Sat, 27 Oct 2018 21:59:21 +0200 Subject: [PATCH] README: Add Nix install instructions (#55) (tested on NixOS. Not yet tested on other Nix-enabled Linux or on Nix-enabled macOS, but should work there, too, I hope.) --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 9fbcca6..06b6237 100644 --- a/README.md +++ b/README.md @@ -134,6 +134,18 @@ If you're an Arch Linux user, you can also install the package from the AUR: $ brew install tealdeer +### Through Nix (NixOS, Linux with Nix or macOS with Nix) + +If you have the Nix package manager, you can use [attribute `tealdeer` from Nixpkgs](https://nixos.org/nixos/packages.html#tealdeer). + +E.g. to run tealdeer without permanently installing it: + + $ nix run nixpkgs.tealdeer -c tldr tar + +or to install tealdeer into the user environment: + + $ nix-env -iA nixos.tealdeer + ## Configuration The tldr command can be customized with a config file called `config.toml`.