diff options
author | Vincent Ambo <mail@tazj.in> | 2018-06-06T14·33+0200 |
---|---|---|
committer | Vincent Ambo <mail@tazj.in> | 2018-06-06T14·33+0200 |
commit | 535eef9de3b5e178570ed5772a8b5e72e05f94ed (patch) | |
tree | ec9d026fbdc53e54a3b687ccb8c2ce61e95ac533 /README.md | |
parent | 1239f26e8a771b4040e8ebd557de0738b4d7d24a (diff) |
docs(README): Update README
It was about time
Diffstat (limited to '')
-rw-r--r-- | README.md | 24 |
1 files changed, 16 insertions, 8 deletions
diff --git a/README.md b/README.md index 5205b618b072..4f2e870f9025 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,23 @@ NixOS configuration =================== -My NixOS config. Some manual steps required before the first run! +My NixOS configuration! It configures most of the packages I require +on my systems, sets up Emacs the way I need and does a bunch of other +interesting things. -Make sure submodules are cloned: `git submodule update --init`. +In contrast with earlier versions of this configuration, the Nix +channel versions are now pinned in Nix (see the beginning of +[packages.nix][]). -Set up the unstable NixOS channel: +Machine-local configuration is kept in files with the naming scheme +`$hostname-configuration.nix` and **must** be symlinked to +`local-configuration.nix` before the first configuration run. -``` -nix-channel --add http://nixos.org/channels/nixos-unstable nixos-unstable -nix-channel --update -``` +I'm publishing this repository (and my [emacs configuration][]) as a +convenience for myself, but also as a resource that people looking for +example Nix or Emacs configurations can browse through. -Symlink local machine configuration to `/etc/nixos/local-configuration.nix`. +Feel free to ping me with any questions you might have. + +[packages.nix]: packages.nix +[emacs configuration]: https://github.com/tazjin/emacs.d |