Updated README with instructions

This commit is contained in:
xezo360hye 2024-07-06 20:39:31 +03:00
parent cf13eb4bbe
commit 10fc937bbb

View File

@ -1,3 +1,21 @@
# nethack.nix
# Nethack configuration module for home-manager
Nethack configuration module in Nix, for use with home-manager
TLDR: [home-manager](https://github.com/nix-community/home-manager/) module for easier `.nethackrc` configuration.
## Usage
1. Add this repo to inputs:
```nix
inputs.nethack.url = git+ssh://git@git.psf.lt/xezo360hye/nethack;
```
2. Use the input as module:
```nix
outpus.homeConfigurations."user@host" = home-manager.lib.homeManagerConfiguration {
modules = [
nethack.homeManagerModules.nethack
./home.nix
];
};
```