Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
isabelroses committed Feb 10, 2024
1 parent 9c0fd09 commit 25900d2
Showing 1 changed file with 59 additions and 32 deletions.
91 changes: 59 additions & 32 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,39 @@
<div align="center">
<h1>isabel's dotfiles</h1>

<img src="https://img.shields.io/github/stars/isabelroses/dotfiles?color=f5c2e7&labelColor=303446&style=for-the-badge&logo=starship&logoColor=f5c2e7">
<img alt="stars" src="https://img.shields.io/github/stars/isabelroses/dotfiles?color=f5c2e7&labelColor=303446&style=for-the-badge&logo=starship&logoColor=f5c2e7">
<img alt="ci" src="https://img.shields.io/github/actions/workflow/status/isabelroses/dotfiles/check.yml?label=build&color=a6e3a1&labelColor=303446&style=for-the-badge&logo=github&logoColor=a6e3a1" />
<img src="https://img.shields.io/github/repo-size/isabelroses/dotfiles?color=fab387&labelColor=303446&style=for-the-badge&logo=github&logoColor=fab387">
<img alt="repo size" src="https://img.shields.io/github/repo-size/isabelroses/dotfiles?color=fab387&labelColor=303446&style=for-the-badge&logo=github&logoColor=fab387">
</div>

### Install Notes
<!--toc:start-->
- [What does this repo provided](#what-does-this-repo-provided)
- [Hyprland Shortcuts](#hyprland-shortcuts)
- [Config layout](#config-layout)
- [Install Notes](#install-notes)
- [Linux](#linux)
- [macOS (WIP)](#macos-wip)
- [Some Awesome people](#some-awesome-people)
<!--toc:end-->

#### Linux
### What does this repo provided

- Install [NixOS](https://nixos.org/download.html)
- Clone this repository to `~/.config/flake`
- Run `sudo nixos-rebuild switch --flake ~/.config/flake#<host>`

#### MacOS
- Several applications and tools for the same purpose, so you can choose the one that best suits your needs
- `neovim`, `micro` and `vscode` for text editing
- `firefox` and `chromium` for web browsing
- `alacritty`, `kitty` and `wezterm` for terminal emulators
- `bash`, `zsh`, `fish` and `nushell` for shells
- Modular configuration, so you can add or remove parts of the configuration
- Sensible defaults, so you can get started quickly
- [Catppuccin](https://github.com/catppuccin/catppucin) everywhere

- Install [homebrew](https://brew.sh/)
> `curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh | bash`
- Exclude nix from time machine backups
> `sudo tmutil addexclusion -v /nix`
- `nix run nix-darwin -- switch --flake ~/.config/flake#<host> --experimental-features "nix-command flakes"`
- Then good news you can use the `rebuild` alias that exists for the future
<details>

### Config layout
<summary>

- 🏠 [home](../home/)
- πŸ–₯️ [hosts](../hosts/)
- β˜€οΈ [Amaterasu](../hosts/amatarasu/) My high-end gaming machine
- πŸͺ„ [Luz](../hosts/luz/) A server configuration for some of my infrastructure
- πŸ‰ [Hydra](../hosts/hydra/) A super mid spec laptop
- ⚸ [Lilith](../hosts/lilith/) A NixOS ISO image that can be quickly deployed and accessed via ssh
- πŸ“– [lib](../lib/) Useful repeated functions
- 🧩 [flake](../flake/) NixOS parts breaking down the complex configuration into smaller more manageable chunks
- πŸ”Œ [modules](../modules/)
- [common](../modules/base/) The base configuration settings, which are common between all systems
- [base](../modules/base/common/) Core parts of the configuration
- [options](../modules/base/options/) Selectable settings that can be used to toggle certain settings
- [extra](../modules/extra) Extra configuration modules, for home-manager and NixOS
- [profiles](../modules/profiles/) System type configurations (e.g. laptop, servers, desktop)
#### Hyprland Shortcuts

<details>
<summary> Hyprland Shortcuts </summary>
</summary>

| Shortcut | What it does |
| ------------------------------- | -------------------------- |
Expand All @@ -58,6 +50,41 @@

</details>

### Config layout

- 🏠 [home](../home/)
- πŸ–₯️ [hosts](../hosts/)
- β˜€οΈ [Amaterasu](../hosts/amatarasu/) My high-end gaming machine
- πŸ‰ [Hydra](../hosts/hydra/) A super mid spec laptop
- ⚸ [Lilith](../hosts/lilith/) A NixOS ISO image that can be quickly deployed and accessed via ssh
- πŸͺ„ [Luz](../hosts/luz/) A server configuration for some of my infrastructure
- 𖀍 [Valkyrie](../hosts/valkyrie/) A WSL2 machine
- 𖀍 [Tatsumaki](../hosts/tatsumaki/) A WIP macOS host
- πŸ“– [lib](../lib/) Useful repeated functions
- 🧩 [flake](../flake/) NixOS parts breaking down the complex configuration into smaller more manageable chunks
- πŸ”Œ [modules](../modules/)
- [base](../modules/base/) The base configuration settings, which are common between all systems
- [options](../modules/options/) Selectable settings that can be used to toggle certain settings
- [extra](../modules/extra) Extra configuration modules, for home-manager and NixOS
- [profiles](../modules/profiles/) System type configurations (e.g. laptop, servers, desktop)

### Install Notes

#### Linux

- Install [NixOS](https://nixos.org/download.html)
- Clone this repository to `~/.config/flake`
- Run `sudo nixos-rebuild switch --flake ~/.config/flake#<host>`

#### macOS (WIP)

- Install [homebrew](https://brew.sh/)
> `curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh | bash`
- Exclude nix from time machine backups
> `sudo tmutil addexclusion -v /nix`
- `nix run nix-darwin -- switch --flake ~/.config/flake#<host> --experimental-features "nix-command flakes"`
- Then good news you can use the `rebuild` alias that exists for the future

### Some Awesome people

[NotAShelf](https://github.com/notashelf/nyx) - [numtide/srvos](https://github.com/numtide/srvos) - [nullishamy](https://github.com/nullishamy/derivation-station) - [nekowinston](https://github.com/nekowinston/dotfiles) - [getchoo](https://github.com/getchoo) - [nyxkrage](https://github.com/nyxkrage)

0 comments on commit 25900d2

Please sign in to comment.