rf/README.md
2019-06-12 14:02:26 +12:00

1.9 KiB

Regular Flolloping

tA's Blog, currently hosted at Regular Flolloping

Getting Started

What you need to get the generator up and running.

Prerequisites

Built using Nix. Nix can be installed with:

curl https://nixos.org/nix/install | sh

Dependencies

imagemagick is required for the favicons.

Installing

Enter the build environment

nix-shell --pure

Compile the generator

nix-build

Generate the site

./result/site rebuild

And test it out

./result/site watch

The site will now be avaliable at localhost:8000

Deployment

Site will be completely static, so simply point your server to the _site directory

if you edit the values in rfg.sh to point to your git repo, you can run;

nix-shell --pure --run "./rfg.sh"

to automatically build up upload a gopher mirror, such as to work with 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

Versioning

Is very airy fairy and mainly based on what I think constitutes major / minor updates.

Check the ChangeLog for changes, if I remember to write them.

Authors

  • Shaun Kerr - tA

License

This project is licensed under the BSD2 License - see the LICENSE file for details

Acknowledgments

  • Hakyll for having an incredible default, of which 90% was kept i gutted for a crappy light on dark style
  • Elie Génard for their favicon library, very easy to use.
  • Douglas Adam's for providing the name
  • You, for reading this :)