92 lines
1.8 KiB
Markdown
92 lines
1.8 KiB
Markdown
# Regular Flolloping
|
|
|
|
tA's Blog, currently hosted at [Regular Flolloping](https://regularflolloping.com)
|
|
|
|
## 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
|
|
|
|
Compile the generator
|
|
|
|
```
|
|
nix-build rf.nix
|
|
```
|
|
|
|
Enter the build environment
|
|
|
|
```
|
|
nix-shell --pure
|
|
```
|
|
|
|
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](rfg.sh) or [notNixOSrfg.sh](notNixOSrfg.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
|
|
|
|
## Built With
|
|
|
|
* [Hakyll](https://jaspervdj.be) - The web framework used
|
|
* [hakyll-favicon](https://github.com/elaye/hakyll-favicon) - Thanks Elie!
|
|
* [Nix](https://nixos.org) - Package Management
|
|
* [Cabal](https://cabal.readthedocs.io) - Build System
|
|
|
|
## Versioning
|
|
|
|
Is very airy fairy and mainly based on what I think constitutes major / minor updates.
|
|
|
|
## Authors
|
|
|
|
* **Shaun Kerr** - [tA](https://github.com/techieAgnostic)
|
|
|
|
## License
|
|
|
|
This project is licensed under the BSD3 License - see the [LICENSE](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 :)
|