about summary refs log tree commit diff
path: root/devhell/README.md
diff options
context:
space:
mode:
authoraszlig <aszlig@redmoonstudios.org>2017-06-22 00:39:53 +0200
committeraszlig <aszlig@redmoonstudios.org>2017-06-22 00:39:53 +0200
commit3e94e96826f522c31e054bae1b5fd1af2cbfb309 (patch)
tree9c23966184ed4b2bd8437019281d61c6a6cd1fef /devhell/README.md
parentbd3547a7194ab01a33346fcff837e7c8cd50a5f7 (diff)
parent4ba315934a9d3727a0bc0ff392c706d9bda57ce7 (diff)
Subtree-merge https://github.com/devhell/nixosconf
This introduces a new participant of the vuizvui project, @devhell.

Welcome abord :-)

So far the whole repository is now inside the devhell/ subdirectory and
we now need to factor out the configs into the vuizvui ecosystem.
Diffstat (limited to 'devhell/README.md')
-rw-r--r--devhell/README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/devhell/README.md b/devhell/README.md
new file mode 100644
index 00000000..d8d987c7
--- /dev/null
+++ b/devhell/README.md
@@ -0,0 +1,34 @@
+# nixosconf
+_NixOS configuration for my current machines._
+
+Feel free to use and adapt as you wish.
+
+In case you've wondered where to start, normally it's enough to simply import
+the `entry-*.nix` file, respective of the machine you want to build (naturally
+you can also just rename the files to reflect your own configuration/machine
+names), into your `/etc/nixos/configuration.nix`, for example:
+```
+{ config, pkgs, lib, ... }:
+
+{
+  imports =
+    [
+      /home/<username>/nixosconf/entry-<machinename>.nix
+    ];
+}
+```
+
+**NOTE:** This NixOS configuration is geared towards people running NixOS
+_unstable_ or `nixpkgs` [master branch](https://github.com/NixOS/nixpkgs). This
+also means that if `nixos-rebuild switch` encounters an error, then it is likely
+that whatever caused the error has not yet been included in the latest Hydra
+channel update (this is assuming that you are using the _unstable_ channel).
+Therefore your best bet is to either disable the culprit in the configuration
+or just wait until the [unstable channel](https://hydra.nixos.org/job/nixos/trunk-combined/tested#tabs-constituents)
+has been updated. Or, of course, run directly from `nixpkgs` master branch.
+
+**NOTE 2:** Unless you have access to a Hydra build farm/machine you will most
+likely want to remove the `binaryCaches` option in the `machine_common.nix`
+file. This also means that you can ignore the `release.nix` file. Unless, of
+course, you have access to a Hydra, in which case you'll still want to adapt
+the `binaryCache` option.