rf/README.md

93 lines
1.9 KiB
Markdown
Raw Normal View History

2018-08-18 07:24:54 -04:00
# Regular Flolloping
2018-08-19 21:08:34 -04:00
tA's Blog, currently hosted at [Regular Flolloping](https://regularflolloping.com)
2018-08-18 07:24:54 -04:00
## Getting Started
What you need to get the generator up and running.
### Prerequisites
Built using Nix.
2018-08-18 07:24:54 -04:00
Nix can be installed with:
```
curl https://nixos.org/nix/install | sh
```
2018-08-24 22:31:46 -04:00
### Dependencies
`imagemagick` is required for the favicons.
2018-08-18 07:24:54 -04:00
### Installing
2018-09-03 21:32:43 -04:00
Enter the build environment
```
2018-09-04 18:48:17 -04:00
nix-shell --pure
2018-09-03 21:32:43 -04:00
```
2019-06-11 22:02:26 -04:00
Compile the generator
```
nix-build
```
2018-08-18 07:24:54 -04:00
Generate the site
```
2018-09-03 21:32:43 -04:00
./result/site rebuild
2018-08-18 07:24:54 -04:00
```
And test it out
```
2018-08-19 22:20:18 -04:00
./result/site watch
2018-08-18 07:24:54 -04:00
```
The site will now be avaliable at `localhost:8000`
## Deployment
2019-06-11 22:34:51 -04:00
Site will be completely static, so simply point your server to the `_http` directory
2018-08-18 07:24:54 -04:00
2019-06-11 22:02:26 -04:00
if you edit the values in [rfg.sh](rfg.sh) to point to your git repo, you can run;
2019-03-05 08:04:11 -05:00
```
nix-shell --pure --run "./rfg.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
2019-06-11 22:02:26 -04:00
if you're not running NixOS, then please edit the bang line in the script to point to your bash installation.
2018-08-18 07:24:54 -04:00
## Built With
* [Hakyll](https://jaspervdj.be) - The web framework used
* [hakyll-favicon](https://github.com/elaye/hakyll-favicon) - Thanks Elie!
2018-08-18 07:24:54 -04:00
* [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.
2019-06-11 22:02:26 -04:00
Check the [ChangeLog](ChangeLog.md) for changes, if I remember to write them.
2018-08-18 07:24:54 -04:00
## Authors
2019-06-11 22:02:26 -04:00
* **Shaun Kerr** - [tA](https://git.lain.church/tA)
2018-08-18 07:24:54 -04:00
## License
2019-06-11 22:02:26 -04:00
This project is licensed under the BSD2 License - see the [LICENSE](LICENSE) file for details
2018-08-18 07:24:54 -04:00
## Acknowledgments
2018-08-23 00:25:17 -04:00
* 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.
2018-08-18 07:24:54 -04:00
* Douglas Adam's for providing the name
* You, for reading this :)