aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCody Hiar <cody@hiar.ca>2022-06-08 21:12:27 -0600
committerCody Hiar <cody@hiar.ca>2022-06-08 21:12:27 -0600
commit1dfb0beddb27cd5420214f875f484621ac86bdb6 (patch)
treeba770882dfa58dd60aabbf9ec975ecb22c4b90b7 /README.md
parentbd3fe5b914b521279fcfb08aa8c5e58037cbe4f8 (diff)
Cleaning up
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 13 insertions, 2 deletions
diff --git a/README.md b/README.md
index 349a53b..aa25ed6 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,14 @@
-# Neovim Setup
+# Neovim flake
-Run with `nix run git+https://git.codyhiar.com/config/nvim`
+A [Nixos Flake][1] for Neovim. Installs binary packages, plugins, and
+`init.lua`. To use on existing nix setup, run:
+
+```
+nix run git+https://git.codyhiar.com/config/nvim
+```
+
+The flake is intentionally kept as simple as possible. When I read other
+examples online, they were not always easy to follow. The `flake.nix` tries to
+stick to the interface described in the [Nixos Wiki][1] without using any magic.
+
+[1]: https://nixos.wiki/wiki/Flakes