From 44a2221d94b389c382a3a631282689a8e4daac35 Mon Sep 17 00:00:00 2001 From: techieAgnostic Date: Wed, 12 Jun 2019 14:02:26 +1200 Subject: [PATCH] updated readme --- README.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 808bc1f..1f16c19 100644 --- a/README.md +++ b/README.md @@ -20,18 +20,19 @@ curl https://nixos.org/nix/install | sh ### Installing -Compile the generator - -``` -nix-build rf.nix -``` - Enter the build environment ``` nix-shell --pure ``` +Compile the generator + +``` +nix-build +``` + + Generate the site ``` @@ -50,20 +51,18 @@ The site will now be avaliable at `localhost:8000` Site will be completely static, so simply point your server to the `_site` directory -if you edit the values in [rfg.sh](rfg.sh) or [notNixOSrfg.sh](notNixOSrfg.sh) to point to your git repo, you can run; +if you edit the values in [rfg.sh](rfg.sh) to point to your git repo, you can run; ``` nix-shell --pure --run "./rfg.sh" ``` -or -``` -nix-shell --pure --run "./notNixOSrfg.sh" -``` to automatically build up upload a gopher mirror, such as to work with [lain.church](https://lain.church) this will also build the http site +if you're not running NixOS, then please edit the bang line in the script to point to your bash installation. + ## Built With * [Hakyll](https://jaspervdj.be) - The web framework used @@ -75,13 +74,15 @@ this will also build the http site Is very airy fairy and mainly based on what I think constitutes major / minor updates. +Check the [ChangeLog](ChangeLog.md) for changes, if I remember to write them. + ## Authors -* **Shaun Kerr** - [tA](https://github.com/techieAgnostic) +* **Shaun Kerr** - [tA](https://git.lain.church/tA) ## License -This project is licensed under the BSD3 License - see the [LICENSE](LICENSE) file for details +This project is licensed under the BSD2 License - see the [LICENSE](LICENSE) file for details ## Acknowledgments