From 86ca002b4eda27cac76c6bdc87dc7cef9a970aa3 Mon Sep 17 00:00:00 2001
From: Zane van Iperen <zane@zanevaniperen.com>
Date: Fri, 23 Apr 2021 21:05:47 +1000
Subject: README: add NixOS installation instructions

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 01ff0c6..31b49b5 100644
--- a/README.md
+++ b/README.md
@@ -39,6 +39,8 @@ Possible future features:
 
 ## Installation
 
+### Ubuntu
+
 Build-time dependencies:
 
     sudo apt-get install make pkg-config lua5.2 bash-completion wget unzip gawk sqlite3
@@ -70,6 +72,22 @@ If it returns lots of errors, you should probably stay with the original databas
 Otherwise, the error messages might help in fixing/upgrading the script.
 You are of course welcome to contribute patches. :-)
 
+### NixOS
+
+`openrussian-cli` is part of the `nixos-unstable` (and soon `nixos-21.05`) channels.
+
+To install `openrussian-cli` on NixOS:
+* Via `configuration.nix`:
+  ```nix
+  environment.systemPackages = [ pkgs.openrussian-cli ];
+  ```
+* Via `nix-env`:
+  ```bash
+  nix-env -iA openrussian-cli
+  ```
+
+See https://nixos.org/manual/nixos/stable/index.html#sec-package-management for more information.
+
 ### Bash Aliases
 
 While the default command name `openrussian` was chosen to avoid cluttering the
-- 
cgit v1.2.3