improve readme clarity

This commit is contained in:
Noah Masur 2023-02-20 20:26:14 -05:00
parent 251dce68bb
commit 0d0ee1fc5a

View File

@ -1,3 +1,5 @@
# System Configurations
This repository contains configuration files for my NixOS, macOS, and WSL This repository contains configuration files for my NixOS, macOS, and WSL
hosts. hosts.
@ -12,25 +14,25 @@ However, some of the configurations are easier to lift directly:
- [Git aliases](https://github.com/nmasur/dotfiles/blob/master/modules/shell/git.nix) - [Git aliases](https://github.com/nmasur/dotfiles/blob/master/modules/shell/git.nix)
- [Hammerspoon](https://github.com/nmasur/dotfiles/tree/master/modules/darwin/hammerspoon) - [Hammerspoon](https://github.com/nmasur/dotfiles/tree/master/modules/darwin/hammerspoon)
Try out my Neovim config: Try out my Neovim config (requires [nix](https://nixos.org/download.html)):
```bash ```bash
nix run github:nmasur/dotfiles#neovim nix run github:nmasur/dotfiles#neovim
``` ```
Or build it as a package: Or build it as a package (requires [nix](https://nixos.org/download.html)):
```bash ```bash
nix build github:nmasur/dotfiles#neovim nix build github:nmasur/dotfiles#neovim
``` ```
If you already have a Neovim configuration, you may need to move it out of If you already have a Neovim configuration, you may need to move it out of
`~/.config/nvim` or set `XDG_CONFIG_HOME` to another value; otherwise, both `~/.config/nvim` or set `XDG_CONFIG_HOME` to another value; otherwise both
configs might conflict with each other. configs might conflict with each other.
--- ---
# Installation # Full Installation
## NixOS - From Live Disk ## NixOS - From Live Disk
@ -42,7 +44,7 @@ installer disk:
```bash ```bash
lsblk # Choose the disk you want to wipe lsblk # Choose the disk you want to wipe
nix-shell -p nixVersions.stable nix-shell -p nixVersions.stable
nix run github:nmasur/dotfiles#installer -- nvme0n1 desktop nix run github:nmasur/dotfiles#installer -- nvme0n1 tempest
``` ```
## NixOS - From Existing System ## NixOS - From Existing System
@ -63,7 +65,7 @@ the WSL configuration:
``` ```
nix-shell -p nixVersions.stable nix-shell -p nixVersions.stable
sudo nixos-rebuild switch --flake github:nmasur/dotfiles#flame sudo nixos-rebuild switch --flake github:nmasur/dotfiles#hydra
``` ```
You should also download the You should also download the