about summary refs log tree commit diff
diff options
context:
space:
mode:
authorVincent Ambo <tazjin@gmail.com>2017-10-25T15·22+0200
committerVincent Ambo <tazjin@gmail.com>2017-10-25T15·22+0200
commitdfe1f191a9960c9e05403f040802ec942febe284 (patch)
tree5cbe2614ffaa53bef3c2f35bb1809dea07c96e5c
parentfa224c48d9b3df4ab4d59d3fb72c055ab133e749 (diff)
docs: Update README with setup instructions
-rw-r--r--README.md13
1 files changed, 6 insertions, 7 deletions
diff --git a/README.md b/README.md
index 970f25e6e9f7..5205b618b072 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,15 @@
 NixOS configuration
 ===================
 
-Set up the unstable channel first:
+My NixOS config. Some manual steps required before the first run!
+
+Make sure submodules are cloned: `git submodule update --init`.
+
+Set up the unstable NixOS channel:
 
 ```
 nix-channel --add http://nixos.org/channels/nixos-unstable nixos-unstable
 nix-channel --update
 ```
 
-## TODO
-
-* [ ] place i3 (and related) configuration automatically
-* [ ] place [emacs configuration](https://github.com/tazjin/emacs.d) automatically
-* [ ] configure channel automatically (if possible)
-* [ ] configure Rust setup
+Symlink local machine configuration to `/etc/nixos/local-configuration.nix`.