Fix configuration, add Documentation

NicolasGuilloux · May 29, 2021 · 4829cd6 · 4829cd6
1 parent 066cd50
commit 4829cd6
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -74,15 +74,16 @@ In your `home.nix` :
 
 This is the configuration of the package itself. You can set them via `programs.shadow-client.<key>`.
 
-| Key                   | Type   | Default | Possible values             | Description                                               |
-|-----------------------|--------|---------|-----------------------------|-----------------------------------------------------------|
-| enable                | bool   | false   | true, false                 | Enable the package                                        |
-| channel               | enum   | prod    | prod, preprod, testing      | `prod` is stable, `preprod` is beta, `testing` is alpha   |
-| launchArgs            | string |         |                             | Add launch arguments to the renderer                      |
-| enableDesktopLauncher | bool   | true    | true, false                 | Creates a .desktop entry                                  |
-| enableDiagnostics     | bool   | false   | true, false                 | Provide debug tools                                       |
-| forceDriver           | enum   | null    | iHD, i965, radeon, radeonsi | Force the LIBVA driver                                    |
-| enableGpuFix          | bool   | true    | true, false                 | Create the `drirc` file to fix some driver related issues |
+| Key                   | Type   | Default | Possible values                | Description                                               |
+|-----------------------|--------|---------|--------------------------------|-----------------------------------------------------------|
+| enable                | bool   | false   | true, false                    | Enable the package                                        |
+| channel               | enum   | prod    | prod, preprod, testing         | `prod` is stable, `preprod` is beta, `testing` is alpha   |
+| extraChannels         | [enum] | []      | [ "prod" "preprod" "testing" ] | `prod` is stable, `preprod` is beta, `testing` is alpha   |
+| launchArgs            | string |         |                                | Add launch arguments to the renderer                      |
+| enableDesktopLauncher | bool   | true    | true, false                    | Creates a .desktop entry                                  |
+| enableDiagnostics     | bool   | false   | true, false                    | Provide debug tools                                       |
+| forceDriver           | enum   | null    | iHD, i965, radeon, radeonsi    | Force the LIBVA driver                                    |
+| enableGpuFix          | bool   | true    | true, false                    | Create the `drirc` file to fix some driver related issues |
 
 
 #### XSession configuration

diff --git a/config.nix b/config.nix
@@ -14,17 +14,16 @@ with lib;
       example = "preprod";
       description = ''
         Choose a channel for the Shadow application.
-        `prod` is the stable channel, `preprod` is the beta channel.
+        `prod` is the stable channel, `preprod` is the beta channel. `testing` is the alpha channel.
       '';
     };
 
     extraChannels = mkOption {
       type = types.listOf (types.enum [ "prod" "preprod" "testing" ]);
-      default = "prod";
-      example = "preprod";
+      default = [];
+      example = [ "preprod" "testing" ];
       description = ''
-        Choose a channel for the Shadow application.
-        `prod` is the stable channel, `preprod` is the beta channel.
+        Choose extra channels to install aside from the main channel
       '';
     };