From 50d3392359930a67ea1da06cf1ff23c069b25c9c Mon Sep 17 00:00:00 2001 From: atagen Date: Wed, 21 May 2025 20:58:08 +1000 Subject: [PATCH] docs: improve --- README.md | 28 ++++++++++++++++++++-------- 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9cbab2d..a797c13 100644 --- a/README.md +++ b/README.md @@ -2,25 +2,37 @@ `smooooth` is a service to "hot reload" flake-based nixos configurations. -it will detect changes to the specified path, wait for blockers to resolve, + +## like seven inches from a midday sun + +it will detect changes to the specified path, wait for blockers to resolve, \ then trigger build + activation of the new config. -blockers can be specified as any executable name. they will prevent reloads -until they disappear or change their working directory - this way, -`smooooth` can wait for your current editor/shell/you-name-it session +blockers can be specified as any executable name. they will prevent reloads \ +until they disappear or change their working directory - this way, \ +`smooooth` can wait for your current editor/shell/you-name-it session \ to conclude before rebuilding anything. -the only strict requirement is that said executable handles its cwd properly, -so it can be read from the procfs. this may conflict with behaviour of some +the only strict requirement is that said executable handles its cwd properly, \ +so it can be read from the procfs. this may conflict with behaviour of some \ editors (ie. vscode), particularly if started via a .desktop, instead of in situ. -disclaimer: `smooooth` is in a very early but entirely functional state. +disclaimer: `smooooth` is in a very early but entirely functional state. \ it may be subject to changes, full rewrites, or unending neglect. enjoy ! -## module documentation +## i hear you whispering the words + +simply add `smooooth.url = git+https://git.atagen.co/atagen/smooooth.git` to your \ +flake inputs, and the reciprocal `{ smooooth }` entry to your output function. + +now you can import `smooooth.nixosModules.smooooth` in your config modules, and \ +utilise the below listed options to get started ! + + +## to melt everyone, but you stay so cold ### services.smooooth.enable