aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoruser@node5.net <user@node5.net>2026-03-15 21:58:51 +0100
committeruser@node5.net <user@node5.net>2026-03-15 22:07:24 +0100
commitdfff12009954f035dc15429f666fcb776a1cd43a (patch)
tree68a87da54c910f7944b5d5aceefa8295fa17ea6b
parent120a33f6bdb0f26085cab5250f97cb2817a40111 (diff)
move doc to readme
-rw-r--r--README.md28
-rw-r--r--flake.nix28
2 files changed, 26 insertions, 30 deletions
diff --git a/README.md b/README.md
index db401ad..20ed626 100644
--- a/README.md
+++ b/README.md
@@ -6,9 +6,9 @@
nix run git+https://git.node5.net/nix/nvim
```
-## Add to NixOS flake
+## Install
-Add this to your inputs
+Add this to your NixOS flake inputs
```nix
node5-nvim.url = "git+https://git.node5.net/nix/nvim";
@@ -19,3 +19,27 @@ And this to `environment.systemPackages`
```nix
inputs.node5-nvim.packages.x86_64-linux.default
```
+
+---
+
+Print current config: `nvf-print-config nvim | bat --language lua`
+
+## Handy shortcuts
+- leader is space
+- `<leader>g` show git diff pop up
+- `<leader>ld` show linter error / warning list at bottom
+- `<leader>/` find text in files - grep text in files
+- `<leader>.` find files - grep files names
+- `CTRL+T` Terminal
+
+## Handy commands
+- `:StripWhitespace` - remove unwanted trailing whitespace
+- `:Noice` command to show a full message history
+
+## TODO
+
+- [ ] TODO Markdown preview new window
+- [ ] TODO Fix dashboard
+- [ ] TODO Smoothscrolling
+- [ ] TODO Undo tree
+
diff --git a/flake.nix b/flake.nix
index 12a7f85..aa4ff34 100644
--- a/flake.nix
+++ b/flake.nix
@@ -1,31 +1,3 @@
-# Print current config: nvf-print-config nvim | bat --language lua
-# Handy shortcuts
-# leader is space
-# <leader>g show git diff pop up
-# <leader>ld show linter error / warning list at bottom
-# <leader>/ find text in files - grep text in files
-# <leader>. find files - grep files names
-# CTRL+T Terminal
-
-# Handy commands
-# :StripWhitespace - remove unwanted trailing whitespace
-# :Noice command to show a full message history
-
-# TODO Markdown preview new window
-# TODO LSP
-# TODO More git integrations
-# TODO Dashboard
-# TODO Smoothscrolling
-# TODO Undo tree
-# TODO Navigation Breadcrumbs
-
-# DONE Gitgutter
-# DONE Migrate existing
-# DONE smear-cursor
-# DONE Theme dark cool colors
-# DONE Show hidden uneeded whitespacing
-# Done File tabs
-
{
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-25.05";