voidarc/nixos
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

made the readme better

Browse Source
This commit is contained in:
voidarc
2026-08-20 14:38:02 +01:00
parent 6b396d8bb9
commit 6519bb657a
1 changed files with 22 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -8,6 +8,22 @@ _An opinionated dendritic nix configuration_
![Picture of Neovim open, editing the hyprland repo](assets/desktop-2-v2.png)
## Get Started
No cloning required
```bash
# Run any app (replace appname with the one you want)
nix run "git+https://git.voidarc.co.uk/voidarc/nixos.git#appname"
# Build configuration (HACKSTATION or mobile02)
sudo nixos-rebuild switch --impure --flake "git+https://git.voidarc.co.uk/voidarc/nixos.git#mobile02"
```
[More Information on Configs](#nixos-configurations)
[More Information on Binaries](#binaries)
## The Concept
I have been trying to get consistent, across device experiences from the second that I
@@ -102,6 +118,9 @@ environment variable is not available, the zsh module will throw and evaluation
but the build will not be hindered.
```bash
# The following commands will only work if your hostname is already
# HACKSTATION or mobile02, if it is not, see next code block
# Local Clone, . is the directory containing flake.nix
sudo nixos-rebuild switch --impure --flake .
@@ -124,7 +143,7 @@ default password is `qwer`. No, that isn't my usual password.
### Binaries
Any binary can be run with the same base command (will change when merged to main)
Any binary can be run with the same base command:
```bash
nix run "git+https://git.voidarc.co.uk/voidarc/nixos.git#appname"
@@ -134,11 +153,11 @@ nix run "git+https://git.voidarc.co.uk/voidarc/nixos.git#appname"
`kitty` or `otter-launcher`. Most if not all modules in a subdirectory will have a module
name corresponding to that directory. This only applies for `default.nix` files, so files
that have different names are not expected to follow this convention, even if there is not
ea `default.nix` in that directory.
a `default.nix` in that directory.
## Issues and contributing
Because this is a private git server, there is no inline way to submit issues,
contributions, or feature ideas. If you should wish, you may send such requests to
<admin@voidarc.co.uk>, with the format found in CONTRIBUTING.md. Failure to follow the
<admin@voidarc.co.uk>, with the format found in [CONTRIBUTING.md]( CONTRIBUTING.md ). Failure to follow the
format found there will most likely result in your email being ignored.