initHEADmaster

1 files changed, 82 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..880fdd9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,82 @@
+[![built with nix](https://img.shields.io/static/v1?logo=nixos&logoColor=white&label=&message=Built%20with%20Nix&color=41439a)](https://builtwithnix.org)
+[![Cachix Cache](https://img.shields.io/badge/cachix-chen-blue.svg)](https://chen.cachix.org)
+
+<p align="center">
+    <img src="./assets/nixos-logo.png" width=30% />
+</p>
+
+<h2 align="center">
+    NixBook: Chen's NixOS Configurations
+</h2>
+
+> Welcome to NixBook, a repository where I share my NixOS and home-manager configuration files for my EliteBook 865 G10.
+
+## Highlights
+
+- **Tmpfs as root & home**: Automatically erases the root (`/`) and home (`/home`) on each boot, ensuring a clean state. Persistent data is managed by the [Impermanence] module (See [tmpfs as root] and [tmpfs as home] for more details).
+- **Encrypted single Btrfs partition**: LUKS enhances security by adding password protection to the disk. Btrfs also supports easy snapshot backups.
+- **Declarative disk partitioning**: eliminates the need for manual partitioning, mounting, and unmounting during the installation phase
+- **Efficient Desktop Environment**: Optimized for productivity with minimal distractions, featuring only essential visual elements. It supports an automatic switch between light and dark themes.
+- **Theorem proving toolchains in PL research**: `abella`, `coq`, `lngen` and `ott` toolchain stuff. Packages maintained by me:
+    - `nixpkgs`: [`lngen`]
+    - [`nur.repos.chen`]: forked version of `abella` ([`abella-modded`]) and `ott` ([`ott-sweirich`])
+
+## Installation
+
+To install the Nixbook configurations on your system, start by booting your computer with a LiveCD. Once you have successfully booted into the LiveCD environment, open a terminal and enter:
+
+```console
+git clone https://github.com/cu1ch3n/nixbook
+cd nixbook/script
+chmod +x ./install.sh
+./install.sh
+```
+
+**IMPORTANT NOTE**: If you are not me and your hardware is not EliteBook 865 G10, please avoid using `./install.sh` directly. Instead, consider adapting the configurations to suit your own hardware and needs. You'll likely need to make adjustments in several very personal places:
+
+- `scripts/disko.nix`: Update the disk device, partitions, and the path to password files.
+- `nixos/hardware.nix`: Generate an initial hardware configuration with `nixos-generate-config` and **carefully** replace the settings accordingly.
+- `nixos/user.nix`: Replace the username if it's not "Chen."
+- `nixos/secrets.nix`: Replace the username.
+- `home-manager/home.nix`: Replace the username.
+- `home-manager/dotfiles/default.nix`: Comment out the configuration unless you're using the same monitor setup.
+- `home-manager/programs/git.nix`: Update your Git settings as needed.
+
+## Post-installation
+
+After the installation, there are a few settings that need to be configured manually. These settings are not managed declaratively through NixOS:
+- Set user fingerprint
+- 1Password SSH & CLI integration
+- Doom Emacs (git clone and install)
+
+## Rebuild NixOS configuration
+
+```console
+just rebuild
+```
+
+## Update flake lock file
+
+```console
+just update
+```
+
+## Preview
+
+### Light
+![](assets/screenshot-light.png)
+![](assets/screenshot-light-0.png)
+![](assets/screenshot-light-1.png)
+
+### Dark
+![](assets/screenshot-dark.png)
+![](assets/screenshot-dark-0.png)
+![](assets/screenshot-dark-1.png)
+
+[`abella-modded`]: https://github.com/nix-community/nur-combined/tree/master/repos/chen/pkgs/abella-modded/default.nix
+[`ott-sweirich`]: https://github.com/nix-community/nur-combined/tree/master/repos/chen/pkgs/ott-sweirich/default.nix
+[`lngen`]: https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/ln/lngen/package.nix
+[`nur.repos.chen`]: https://nur.nix-community.org/repos/chen/
+[Impermanence]: https://github.com/nix-community/impermanence
+[tmpfs as root]: https://elis.nu/blog/2020/05/nixos-tmpfs-as-root/
+[tmpfs as home]: https://elis.nu/blog/2020/06/nixos-tmpfs-as-home/