From 1dad78a9753e608d232085c7550db5d9ed4bb090 Mon Sep 17 00:00:00 2001 From: waifu Date: Fri, 1 Apr 2022 01:42:00 +0000 Subject: [PATCH] Expanded readme Added the dumbed down basic usage of the hugo engine and links to the current requirements. --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7b829ce..0d37685 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ # fedi-admin-guide -The bub's guide to being a fediverse admin. \ No newline at end of file +The bub's guide to being a fediverse admin. + + +## Requirements: + +* [Hugo](https://gohugo.io/) 0.68 or higher +* [Hugo-book](https://github.com/alex-shpak/hugo-book) theme. + +## Usage: + +You can have a live version of this website in [localhost:1313](http://localhost:1313/) by cloning this repository, adding the theme as a submodule and running hugo server: + + git clone https://git.froth.zone/Bubs/fedi-admin-guide fedi-admin-guide + cd fedi-admin-guide + git submodule add https://github.com/alex-shpak/hugo-book themes/hugo-book + hugo server + +After this you can also run `hugo` to generate a static website in the fedi-admin-guide/public folder. \ No newline at end of file