made the readme better
This commit is contained in:
23
README.md
23
README.md
@@ -8,6 +8,22 @@ _An opinionated dendritic nix configuration_
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
## 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
|
## The Concept
|
||||||
|
|
||||||
I have been trying to get consistent, across device experiences from the second that I
|
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.
|
but the build will not be hindered.
|
||||||
|
|
||||||
```bash
|
```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
|
# Local Clone, . is the directory containing flake.nix
|
||||||
sudo nixos-rebuild switch --impure --flake .
|
sudo nixos-rebuild switch --impure --flake .
|
||||||
|
|
||||||
@@ -124,7 +143,7 @@ default password is `qwer`. No, that isn't my usual password.
|
|||||||
|
|
||||||
### Binaries
|
### 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
|
```bash
|
||||||
nix run "git+https://git.voidarc.co.uk/voidarc/nixos.git#appname"
|
nix run "git+https://git.voidarc.co.uk/voidarc/nixos.git#appname"
|
||||||
@@ -134,7 +153,7 @@ 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
|
`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
|
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
|
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
|
## Issues and contributing
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user