Add README.md
This commit is contained in:
27
README.md
Normal file
27
README.md
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
# aether
|
||||||
|
Aether is a Hugo theme for blogs that emphasizes motion, depth, and material as design elements. Aether presents your content in a clean interface that highlights good photography and writing.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
In your Hugo project's theme directory, clone the Aether repo.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/josephhutch/aether.git
|
||||||
|
```
|
||||||
|
|
||||||
|
Add the following parameters in your config file if they are not present already.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
baseURL = "https://yourwebsitenamegoeshere.com/"
|
||||||
|
languageCode = "Your language code"
|
||||||
|
title = "Your Website Title"
|
||||||
|
theme = "aether"
|
||||||
|
|
||||||
|
[params]
|
||||||
|
brand = "joehutch"
|
||||||
|
description = "Your website's description."
|
||||||
|
homeimg = "url to the image used for the home button"
|
||||||
|
bgimg = "/img/ignasi_pattern_s.png"
|
||||||
|
```
|
||||||
|
|
||||||
|
## License
|
||||||
|
MIT © Joe Hutchinson
|
||||||
Reference in New Issue
Block a user