dotfiles/README.md

96 lines
5.1 KiB
Markdown
Raw Permalink Normal View History

2023-02-21 01:26:14 +00:00
# System Configurations
2022-07-20 15:50:04 +00:00
This repository contains configuration files for my NixOS, macOS, and WSL
hosts.
2022-09-23 18:35:14 +00:00
They are organized and managed by [Nix](https://nixos.org), so some of the
configuration may be difficult to translate to a non-Nix system.
## System Features
| Feature | Program | Configuration |
2024-06-06 21:08:40 +00:00
|----------------|-----------------------------------------------------|-----------------------------------------------|
| OS | [NixOS](https://nixos.org) | [Link](./modules/nixos) |
| Display Server | [X11](https://www.x.org/wiki/) | [Link](./modules/nixos/graphical/xorg.nix) |
| Compositor | [Picom](https://github.com/yshui/picom) | [Link](./modules/nixos/graphical/picom.nix) |
| Window Manager | [i3](https://i3wm.org/) | [Link](./modules/nixos/graphical/i3.nix) |
| Panel | [Polybar](https://polybar.github.io/) | [Link](./modules/nixos/graphical/polybar.nix) |
| Font | [Victor Mono](https://rubjo.github.io/victor-mono/) | [Link](./modules/nixos/graphical/fonts.nix) |
| Launcher | [Rofi](https://github.com/davatorium/rofi) | [Link](./modules/nixos/graphical/rofi.nix) |
## User Features
| Feature | Program | Configuration |
2024-06-06 21:08:40 +00:00
|--------------|----------------------------------------------------------------------------------|----------------------------------------------------|
| Dotfiles | [Home-Manager](https://github.com/nix-community/home-manager) | [Link](./modules/common) |
| Terminal | [Kitty](https://sw.kovidgoyal.net/kitty/) | [Link](./modules/common/applications/kitty.nix) |
| Shell | [Fish](https://fishshell.com/) | [Link](./modules/common/shell/fish) |
2024-06-06 21:08:40 +00:00
| Shell Prompt | [Starship](https://starship.rs/) | [Link](./modules/common/shell/starship.nix) |
2023-06-24 21:15:39 +00:00
| Colorscheme | [Gruvbox](https://github.com/morhetz/gruvbox) | [Link](./colorscheme/gruvbox/default.nix) |
| Wallpaper | [Road](https://gitlab.com/exorcist365/wallpapers/-/blob/master/gruvbox/road.jpg) | [Link](./hosts/tempest/default.nix) |
| Text Editor | [Neovim](https://neovim.io/) | [Link](./modules/common/neovim/config) |
| Browser | [Firefox](https://www.mozilla.org/en-US/firefox/new/) | [Link](./modules/common/applications/firefox.nix) |
| E-Mail | [Aerc](https://aerc-mail.org/) | [Link](./modules/common/mail/aerc.nix) |
| File Manager | [Nautilus](https://wiki.gnome.org/action/show/Apps/Files) | [Link](./modules/common/applications/nautilus.nix) |
| PDF Reader | [Zathura](https://pwmt.org/projects/zathura/) | [Link](./modules/common/applications/media.nix) |
| Video Player | [mpv](https://mpv.io/) | [Link](./modules/common/applications/media.nix) |
## macOS Features
| Feature | Program | Configuration |
2024-06-06 21:08:40 +00:00
|----------|---------------------------------------------|--------------------------------------|
| Keybinds | [Hammerspoon](https://www.hammerspoon.org/) | [Link](./modules/darwin/hammerspoon) |
2022-09-23 18:35:14 +00:00
2024-01-08 00:05:13 +00:00
# Diagram
![Diagram](https://github.com/nmasur/dotfiles/assets/7386960/4cc22285-cea1-4831-b387-a82241184381)
2024-01-08 00:07:16 +00:00
---
2024-01-02 01:01:17 +00:00
# Unique Configurations
2024-01-15 04:05:06 +00:00
This repo contains a few more elaborate elements of configuration.
2024-01-02 01:01:17 +00:00
- [Neovim config](./modules/common/neovim/default.nix) generated with Nix2Vim
2024-01-15 04:05:06 +00:00
and source-controlled plugins, differing based on installed LSPs, for example.
- [Caddy JSON](./modules/nixos/services/caddy.nix) file (routes, etc.) based
dynamically on enabled services rendered with Nix.
- [Grafana config](./modules/nixos/services/grafana.nix) rendered with Nix.
2024-01-02 01:01:17 +00:00
- Custom [secrets deployment](./modules/nixos/services/secrets.nix) similar to
agenix.
2024-01-15 04:05:06 +00:00
- Base16 [colorschemes](./colorscheme/) applied to multiple applications,
including Firefox userChrome.
2024-01-02 01:01:17 +00:00
---
# Installation
Click [here](./docs/installation.md) for detailed installation instructions.
2022-09-23 18:35:14 +00:00
# Neovim
Try out my Neovim config with nix:
2022-11-30 03:48:46 +00:00
```bash
nix run github:nmasur/dotfiles#neovim
```
Or build it as a package:
2022-11-30 03:48:46 +00:00
```bash
nix build github:nmasur/dotfiles#neovim
```
2022-12-07 00:40:13 +00:00
If you already have a Neovim configuration, you may need to move it out of
2023-02-21 01:26:14 +00:00
`~/.config/nvim` or set `XDG_CONFIG_HOME` to another value; otherwise both
2022-12-07 00:40:13 +00:00
configs might conflict with each other.
2022-07-27 23:13:41 +00:00
# Flake Templates
2022-07-20 15:50:04 +00:00
2022-07-27 23:13:41 +00:00
You can also use the [templates](./templates/) as flakes for starting new
projects:
2022-07-20 15:50:04 +00:00
```bash
nix flake init --template github:nmasur/dotfiles#poetry
```