atagen/smooooth
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: improve

Browse Source 
.

.
This commit is contained in:
atagen 2025-05-21 20:58:08 +10:00
parent 7fbeb1e931
commit 5dfed7c5f4
1 changed files with 24 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -2,25 +2,40 @@
`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
`smooooth` will detect changes to the specified flake, 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
editors (ie. vscode), particularly if started via a .desktop, instead of in situ.
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
they are started via a .desktop shortcut.
disclaimer: `smooooth` is in a very early but entirely functional state.
#### a brief 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