diff --git a/README.md b/README.md index dc385cf..c15807e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ -# nethack.nix +# Nethack configuration module for home-manager -Nethack configuration module in Nix, for use with home-manager \ No newline at end of file +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 + ]; +}; +```