From 93d9408a23e7693af7aa3a36d5df33a19c825523 Mon Sep 17 00:00:00 2001 From: aszlig Date: Fri, 11 Dec 2015 04:21:06 +0100 Subject: README: Replace content with a link to the manual. We don't want to have duplicate and different versions of documentation laying around, so let's just provide a link to the latest Hydra build of the manual. Signed-off-by: aszlig --- README.md | 38 +++++++------------------------------- 1 file changed, 7 insertions(+), 31 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index d94996c0..37d71f5b 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,13 @@ About Vuizvui ============= -This contains a [set of NixOS modules/configs][manual] and various other Nix -expressions used by OpenLab and its members. +This contains a set of NixOS modules/configurations and various other Nix +expressions used by [OpenLab Augsburg](https://openlab-augsburg.de) and its +members. -The name "vuizvui" is of Bavarian origins and means something like "too much" -while on the other side "nix" means nothing. Which fits quite well because this -repository is for everything either too complex or not polished/generic enough -to be pushed into [nixpkgs]. - -Hydra builds: https://headcounter.org/hydra/jobset/openlab/vuizvui - -[nixpkgs]: https://github.com/NixOS/nixpkgs -[manual]: https://headcounter.org/hydra/job/openlab/vuizvui/manual/latest/download/1/manual.html - -## Installing a machine - -To enable a vuizvui configuration, first set the nix channel to the corresponding channel build by the hydra, e.g. - - nix-channel --add https://headcounter.org/hydra/channel/custom/openlab/vuizvui/channels.machines.labnet.labtop vuizvui - nix-channel --update - -You have to use the same channel name as is defined by the option `vuizvui.channelName`, `vuizvui` by default. - -Then import the `use` module in your configuration, like this: - -```nix -{ pkgs, lib, ...}: -{ - imports = [ (import {}).labnet.labtop.use ]; -} -``` +Documentation +============= - nixos-rebuild switch +You can find the latest build of the documentation here: -All set. \ No newline at end of file +https://headcounter.org/hydra/job/openlab/vuizvui/manual/latest/download -- cgit 1.4.1