rf/README.md
2018-08-18 23:24:54 +12:00

1.3 KiB

Regular Flolloping

tA's Blog

Getting Started

What you need to get the generator up and running.

Prerequisites

Assumes you have Cabal and Nix.
Nix can be installed with:

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

And Cabal can be installed with your package manager of choice.

Installing

Enter the build environment

nix-shell --attr env rf.nix

Compile the generator

cabal build

Generate the site

cabal run site clean
cabal run site build

And test it out

cabal run 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

Built With

  • Hakyll - The web framework used
  • Nix - Package Management
  • Cabal - Build System

Versioning

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

Authors

  • Shaun Kerr - tA

License

This project is licensed under the BSD3 License - see the LICENSE.md file for details

Acknowledgments

  • Hakyll for having an incredible default, of which 90% was kept
  • Douglas Adam's for providing the name
  • You, for reading this :)