Added the dumbed down basic usage of the hugo engine and links to the current requirements.
This commit is contained in:
parent
d537cb5350
commit
1dad78a975
1 changed files with 18 additions and 1 deletions
19
README.md
19
README.md
|
@ -1,3 +1,20 @@
|
|||
# fedi-admin-guide
|
||||
|
||||
The bub's guide to being a fediverse admin.
|
||||
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.
|
Loading…
Reference in a new issue