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

fixed markdown

Browse Source
This commit is contained in:
voidarc
2026-06-19 15:04:09 +01:00
parent 597c227b75
commit 39b049d633
1 changed files with 31 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
README.md
View File

@@ -4,49 +4,50 @@ Full Nixos/Hyprland/Nvim setup that I daily drive.
## Installing ## Installing
1. Install nixos using default config (If you are an existing user then skip this step) 1. Install nixos using default config (If you are an existing user then skip this step)
I recommend using the graphical installer and just installing KDE or something, and reccomend using the username user01 I recommend using the graphical installer and just installing KDE or something, and reccomend using the username user01
If you have already decided which config to use, you can also set your hostname accordingly, to either mobile02 or HACKSTATION If you have already decided which config to use, you can also set your hostname accordingly, to either mobile02 or HACKSTATION
2. Clone this repo to `~/.dotfiles` (required for doot to work) 2. Clone this repo to `~/.dotfiles` (required for doot to work)
You will probably have to install/ use a nix shell for git, but you should only need it for this step (`nix shell -p git`)
``` You will probably have to install/ use a nix shell for git, but you should only need it for this step (`nix shell -p git`)
git clone https://git.voidarc.co.uk/voidarc/config ~/.dotfiles --recurse-submodules
``` ```
git clone https://git.voidarc.co.uk/voidarc/config ~/.dotfiles --recurse-submodules
```
3. Use doot to put config files in place BEFORE BUILDING CONFIG 3. Use doot to put config files in place BEFORE BUILDING CONFIG
> [!CAUTION] > [!CAUTION]
> IF YOU HAVE AN EXISTING CONFIG PLEASE BACK UP YOUR HOME DIRECTORY BEFORE RUNNING DOOT!!! > IF YOU HAVE AN EXISTING CONFIG PLEASE BACK UP YOUR HOME DIRECTORY BEFORE RUNNING DOOT!!!
> I would reccomend making a new user called user01 and running from there. > I would reccomend making a new user called user01 and running from there.
> Nixos WILL delete any user account not in the config from passwd, but any existing files in the home directory will remain available. > Nixos WILL delete any user account not in the config from passwd, but any existing files in the home directory will remain available.
> If you wish to use another user, add their config to common.nix > If you wish to use another user, add their config to common.nix
Run the command to get doot for nixos. Use the official repo or mine, either works. Run the command to get doot for nixos. Use the official repo or mine, either works.
``` ```
nix shell github:voidarclabs/nixos.doot nix shell github:voidarclabs/nixos.doot
``` ```
Once you are in the shell, use the `doot` or `doot install` command to link the dotfiles to their proper locations Once you are in the shell, use the `doot` or `doot install` command to link the dotfiles to their proper locations
If there are any existing dotfiles, that doot flags, replace or keep them at your own discression. Keep in mind that If there are any existing dotfiles, that doot flags, replace or keep them at your own discression. Keep in mind that
the "adopt" option will write over the files in the git repo. This is reversible by running `git restore .`, which the "adopt" option will write over the files in the git repo. This is reversible by running `git restore .`, which
resets all unstaged changes back to the latest commit. For more info please refer to `man git-restore`. resets all unstaged changes back to the latest commit. For more info please refer to `man git-restore`.
This step is necessary because the flake for nvim has to exist for the config to build correctly. This step is necessary because the flake for nvim has to exist for the config to build correctly.
4. Build the system config from flake 4. Build the system config from flake
I use HACKSTATION on my main pc, with mobile02 on my laptop. I use HACKSTATION on my main pc, with mobile02 on my laptop.
Mobile02 is reccomended for systems that only have 1 monitor, or people who want fewer packages. HACKSTATION has no Mobile02 is reccomended for systems that only have 1 monitor, or people who want fewer packages. HACKSTATION has no
extra hyprland config for unknown monitors, so YMMV. Here is the command for mobile02. The output name is not case sensitive, extra hyprland config for unknown monitors, so YMMV. Here is the command for mobile02. The output name is not case sensitive,
but conventionally lowercase but conventionally lowercase
``` ```
sudo nixos-rebuild switch --impure --flake ~/.dotfiles/.nixos#mobile02 sudo nixos-rebuild switch --impure --flake ~/.dotfiles/.nixos#mobile02
``` ```
If you have set your hostname, you can enter `zsh` and simply type `nrs`, which will rebuild the system according to your hostname. If you have set your hostname, you can enter `zsh` and simply type `nrs`, which will rebuild the system according to your hostname.
5. Reboot 5. Reboot
If all has gone well, you should be able to reboot and enter hyprland with my config. The mobile02 config will have an SDDM login screen, If all has gone well, you should be able to reboot and enter hyprland with my config. The mobile02 config will have an SDDM login screen,
but HACKSTATION logs in automatically. but HACKSTATION logs in automatically.
## Usage ## Usage
For Hyprland and nvim, see the relevant repos. For Hyprland and nvim, see the relevant repos.