From 7c6dd099ef94b94dfcf7fca984b122194dfe6013 Mon Sep 17 00:00:00 2001 From: Reinout Meliesie Date: Mon, 3 Mar 2025 13:02:11 +0100 Subject: [PATCH] Restructure readme --- readme.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/readme.md b/readme.md index 6104221..df0387b 100644 --- a/readme.md +++ b/readme.md @@ -1,14 +1,20 @@ # Nix Packages +## Description + An assortment of Nix packages not in the official collection. They can either be imported individually or using the overlay if you're on NixOS. These are purposefully written without support for [overriding](https://nixos.org/guides/nix-pills/17-nixpkgs-overriding-packages) in order to minimise complexity. If you want to build upon them I encourage you to fork this repository. ---- +## Examples -Example for using a specific package: +> **Note:** +> You should replace the commits here with the latest one, or whichever one you want to use. +> The hashes will of course differ. + +Using a specific package: ```nix @@ -19,7 +25,7 @@ pkgs . callPackage ( import ( pkgs . fetchurl { ``` -Example for using the NixOS overlay: +Using the NixOS overlay: ```nix @@ -31,7 +37,3 @@ imports = [ ] ; ``` - -> **Note:** -> You should replace the commits here with the latest one, or whichever one you want to use. -> The hashes will of course differ.