From 234033c3b99da0649e7d271ef7f4db21bc48df29 Mon Sep 17 00:00:00 2001
From: Guanran Wang <guanran928@outlook.com>
Date: Tue, 31 Oct 2023 17:19:51 +0800
Subject: [PATCH] readme: add proper readme

---
 README.md | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 68 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 88ff775..6cafe51 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,70 @@
 # nix{os,-darwin} config
-### it just works(tm)
+It just works™
 
-## installation
-dont
+
+## Infomation
+- Flakes: Yes
+- Home Manager: Yes
+
+### Machine-specific
+- File system: Btrfs
+- System encryption: Yes (LUKS)
+
+### User-specific
+- Secrets: sops-nix
+- Display server: Wayland
+- Desktop-environment: Sway
+
+## Structure
+```
+ .
+├──  darwin                          # System configuration
+├──  nixos
+│
+├──  flakes                          # Import-able Flakes
+│  ├──  darwin
+│  └──  nixos
+│
+├──  machines                        # Hardware configuration
+│  ├──  darwin
+│  └──  nixos
+│     ├──  81fw-lenovo-legion-y7000  ### Model
+│     │  ├──  hardware.nix           #### Model-specific hardware configuration
+│     │  └──  machine-1              #### Machine-specific hardware configuration
+│     │
+│     └───  hardware                 ### Reusable hardware configuration
+│        ├──  cpu
+│        ├──  gpu
+│        └──  ...
+│
+├──  users
+│  └──  guanranwang                  ## Your user
+│     │
+│     ├──  darwin                    ### (User-specific) System configuration
+│     ├──  nixos
+│     │
+│     ├──  home-manager              ### (User-specific) Home Manager configuration
+│     │  ├──  darwin
+│     │  └──  nixos
+│     │
+│     └──  secrets                   ### User's secrets managed through sops-nix
+│
+├──  flake.nix
+├──  flake.lock
+│
+└──  README.md
+```
+## Installation:
+
+  ~~Please don't.~~
+
+  1.
+    Clone this repository
+    `$ git clone https://github.com/Guanran928/flake.git`
+
+  2.
+    Add your device's hardware configuration in `./machines` and `./flake.nix`
+
+  3.
+    Install NixOS
+    `$ nixos-install --flake <this flake's directory>#<hostname>`