NotAShelf/nyxexprs
1
0
Fork 0
mirror of https://github.com/NotAShelf/nyxexprs.git synced 2024-11-26 15:16:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs: add binary cache usage

Browse source
This commit is contained in:
raf 2023-11-05 21:18:11 +03:00
parent 16b793a17f
commit 7896b35eba
No known key found for this signature in database
GPG key ID: 02D1DD3FA08B6B29
1 changed files with 36 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
README.md
View file

@ -2,8 +2,43 @@
> My personal package overlay for sharing my most commonly used derivations.
## 📦 Packages
There are several packages exposed by this flake. Each directory in `pkgs` contains a description of the package inside its README.
| Package | Description |
| :----------------- | :------------------------------------------------------------------------------------------------: |
| ani-cli | An up-to-date, auto updated version of ani-cli |
| cloneit | A CLI tool to download specific GitHub directories or files |
| foot-transparent | A patched version of the foot terminal emulator that brings back fullscreen transparency[^1] |
| mov-cli | A cli tool to browse and watch Movies/Shows/TV/Sports |
| rat | Linux shell port of the horizontally spinning rat meme, complete with soundtrack and spin counter. |
| reposilite-bin | A derivation for the reposilite maven repository. |
| rofi-calc-wayland | A wayland patched version of [rofi-calc](https://github.com/svenstaro/rofi-calc) |
| rofi-emoji-wayland | A wayland patched version of [rofi-emoji](https://github.com/Mange/rofi-emoji) |
## Usage
### Binary Cache
Regardless of your setup,you may want to add the [binary cache](https://app.cachix.org/cache/nyx) to your substituters to avoid building the provided packages
on each pull. You may follow the example below to add the binary cache to your system.
```nix
nix.settings = {
builders-use-substitutes = true;
substituters = [
# other substituters
"https://nyx.cachix.org"
];
trusted-public-keys = [
# other trusted keys
"nyx.cachix.org-1:xH6G0MO9PrpeGe7mHBtj1WbNzmnXr7jId2mCiq6hipE="
];
};
```
### NixOS/Home-manager (flakes)
It is as simple as adding a new entry to your inputs with the correct url.
@ -27,6 +62,7 @@ An example `flake.nix` would be as follows:
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
home-manager.url = "github:nix-community/home-manager";
# ↓ add nyxpkgs as a flake input
nyxpkgs.url = "github:notashelf/nyxpkgs";
};
@ -95,20 +131,6 @@ in {
}
```
## 📦 Packages
There are several packages exposed by this flake. Each directory in `pkgs` contains a description of the package inside its README.
| Package | Description |
| :----------------- | :------------------------------------------------------------------------------------------------: |
| ani-cli | An up-to-date, auto updated version of ani-cli |
| cloneit | A CLI tool to download specific GitHub directories or files |
| foot-transparent | A patched version of the foot terminal emulator that brings back fullscreen transparency[^1] |
| rat | Linux shell port of the horizontally spinning rat meme, complete with soundtrack and spin counter. |
| reposilite-bin | A derivation for the reposilite maven repository. |
| rofi-calc-wayland | A wayland patched version of [rofi-calc](https://github.com/svenstaro/rofi-calc) |
| rofi-emoji-wayland | A wayland patched version of [rofi-emoji](https://github.com/Mange/rofi-emoji) |
## 🔧 Contributing
PRs are always welcome.