summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCole Mickens <cole.mickens@gmail.com>2018-11-12 03:48:15 -0800
committerCole Mickens <cole.mickens@gmail.com>2018-11-12 04:13:28 -0800
commit0fc2199ef8f4353ddd8b872b9f8f802abe3233bd (patch)
tree58f3d71e8344ca9505ab2be03ca791f532a75ffe
parentc3d8632f52e6ecc871470671457a9016f502d029 (diff)
README: collapse list of packages by default
Signed-off-by: Cole Mickens <cole.mickens@gmail.com>
-rw-r--r--README.md46
-rw-r--r--build.nix2
-rw-r--r--default.nix4
3 files changed, 18 insertions, 34 deletions
diff --git a/README.md b/README.md
index b45e254..4631d29 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,10 @@ This overlay is built and (somewhat) tested against `nixos-unstable`.
(Sister repositories: [nixpkgs-kubernetes](https://github.com/colemickens/nixpkgs-kubernetes), [nixpkgs-colemickens](https://github.com/colemickens/nixpkgs-colemickens))
+## Packages
+
+<details><summary><em><b>Full list of Packages</b></em></summary>
+
<!--pkgs-->
| Attribute Name | Last Upstream Commit Time |
| -------------- | ------------------------- |
@@ -32,9 +36,9 @@ This overlay is built and (somewhat) tested against `nixos-unstable`.
| pkgs/i3status-rust | [2018-11-09 14:22](https://github.com/greshake/i3status-rust/commits/47cb862c6e1763ae038d79915c2a4c28b073dd8e) |
<!--pkgs-->
-Auto-update script last run: <!--update-->2018-11-12 03:41<!--update-->.
+</details><br/>
-Please open an issue if something is out of date.
+Auto-update script last run: <!--update-->2018-11-12 04:04<!--update-->.
## Usage
@@ -81,10 +85,8 @@ in
{
nixpkgs.overlays = [ (self: super: { sway-beta = waylandPkgs.sway-beta; }) ];
environment.systemPackages =
- with pkgs; [
- vim git
- ] ++
- (with swaypkgs; [
+ with pkgs; [ vim git ] ++
+ (with waylandPkgs; [
grim slurp mako wlstream redshift-wayland # essentials
waybar i3status-rust # optional bars
]);
@@ -102,33 +104,15 @@ dbus-launch --exit-with-session $(which sway-beta)
## Updates
-* `./update.sh`
- * updates `./<pkg>/metadata.nix` with the latest commit+hash for each package.
- * updates `pkgs-*/metadata.nix` to their respective channels
-
-* `nix-build build.nix` builds all overlay packages with certain revs of `nixpkgs`.
-
+* `./update.sh`:
+ * updates `pkgs/<pkg>/metadata.nix` with the latest commit+hash for each package
+ * updates `nixpkgs/<channel>/metadata.nix` per the upstream channel
+ * calls `nix-build build.nix` to build all packages against `nixos-unstable`
+ * pushes to [nixpkgs-wayland on cachix](https://nixpkgs-wayland.cachix.org)
## Binary Cache
-I'm now publishing these builds to
-[`nixpkgs-wayland` on cachix](https://nixpkgs-wayland.cachix.org).
-
-```
-nix-build build.nix | cachix push nixpkgs-wayland
-```
-
-The update script `./update.sh` also does this automatically.
-
-### Usage
+Packages are built as described in the section above and are published to cachix.
-To use the cache:
-
-```bash
-# install cachix
-nix-env -iA cachix -f https://github.com/NixOS/nixpkgs/tarball/889c72032f8595fcd7542c6032c208f6b8033db6
-
-# trust and utilize the cache for this repo
-cachix use nixpkgs-wayland
-```
+See usage instructions at [`nixpkgs-wayland` on cachix](https://nixpkgs-wayland.cachix.org).
diff --git a/build.nix b/build.nix
index 9653507..cae824d 100644
--- a/build.nix
+++ b/build.nix
@@ -4,6 +4,6 @@ let
};
in
[
- pkgs.waylandpkgs
+ pkgs.waylandPkgs
]
diff --git a/default.nix b/default.nix
index 36c98ec..d325afa 100644
--- a/default.nix
+++ b/default.nix
@@ -1,6 +1,6 @@
self: pkgs:
let
-waylandpkgs = {
+waylandPkgs = {
# patched deps
fmt = pkgs.callPackage ./pkgs/fmt {};
@@ -28,5 +28,5 @@ waylandpkgs = {
i3status-rust = pkgs.callPackage ./pkgs/i3status-rust {};
};
in
- waylandpkgs // { inherit waylandpkgs; }
+ waylandPkgs // { inherit waylandPkgs; }