about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorsefidel <contact@sefidel.net>2022-01-10 02:09:30 +0900
committersefidel <contact@sefidel.net>2022-01-10 02:09:30 +0900
commit918166a21008cf0549e7696b87d6a1d57c0019ef (patch)
treeaa2708e64ec023aa2fb73fa26d5a2a6223557a2b /README.md
parent6bb2a7673480b17638a69e5c99f7fd21c7767c7d (diff)
downloadnixrc-918166a21008cf0549e7696b87d6a1d57c0019ef.tar.gz
nixrc-918166a21008cf0549e7696b87d6a1d57c0019ef.zip
README: improve readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/README.md b/README.md
index a698ac9..a0ff44a 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,38 @@
 # nixrc
+[![CI status](https://builds.sr.ht/~boppy/nixrc/commits/.build.yml.svg)](https://builds.sr.ht/~boppy/nixrc/commits/.build.yml)
+[![ISC License](https://img.shields.io/badge/license-ISC-0475b5)](https://www.isc.org/licenses/)
+[![NixOS Unstable](https://img.shields.io/badge/NixOS-unstable-blue.svg?style=flat-square&logo=NixOS&logoColor=white)](https://nixos.org)
+
+## Installation
+1. Creating the installation media
+  ```sh
+  # Acquire latest nixos-unstable build
+  wget -O nixos.iso https://channels.nixos.org/nixos-unstable/latest-nixos-minimal-x86_64-linux.iso
+
+  # Write the image to flash drive
+  cp nixos.iso /dev/sdX
+  ```
+2. Boot into the live installation.
+
+3. Switch to root: `sudo su -`
+
+4. Configure partitions
+
+5. Install this configuration
+
+6. Reboot
+
+7. Happy hacking :)
+
+
+## Resources
++ **Flakes**
+  + [Official docs](https://nixos.org/learn.html)
+  + [NixOS Wiki (Community) - Flakes](https://nixos.wiki/wiki/Flakes)
+  + Some flake configurations that I
+    [may](https://github.com/hlissner/dotfiles)
+    [have](https://github.com/NobbZ/nixos-config)
+    [taken](https://github.com/legendofmiracles/dotnix)
+    [inspiration](https://github.com/fufexan/nixos-config)
+    [from](https://github.com/colemickens/nixos-flake-example).
+