tA/rf
1
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
Thorn Avery 2019-06-12 14:02:26 +12:00
parent 0e981fb9ff
commit 44a2221d94
1 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -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