0xmrtt/gadolinium
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

doc: add readme

Browse source
This commit is contained in:
0xMRTT 2023-05-10 14:15:47 +02:00
parent e36ce68ca3
commit d2e7ccab4b
Signed by: 0xmrtt
GPG key ID: 19C1449A774028BD
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md Normal file
View file

@ -0,0 +1,20 @@
# Gadolinium
This project is a template to build a low key (in terms of product branding) OS component website based on the [Jekyll theme from Jakub Steiner](https://github.com/jimmac/os-component-website/)
## Usage
### Install as git submodule
Navigate to your hugo project root and run:
```
git submodule add https://git.exozy.me/0xmrtt/gadolinium.git themes/gadolinium
```
Then run `hugo` (or set `theme = "gadolinium"` in configuration file)
```
hugo server --minify --theme gadolinium
```