diff --git a/README.md b/README.md index 832ab9b..fe724b9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,29 @@ # The Fresh theme for Hugo -![Fresh theme logo](fresh.png) \ No newline at end of file +**Fresh** is a theme for the [Hugo](https://gohugo.io) static site generator adapted from the gorgeous, [Bulma](https://bulma.io)-based theme of the same name from [CSS Ninja](https://cssninja.io). + +![Fresh theme logo](fresh.png) + +## Getting started + +To create a new site using this theme: + +```bash +# Create site and cd into it +hugo new site my-site && cd my-site + +# Clone the Fresh theme +git clone https://github.com/lucperkins/hugo-fresh themes/hugo-fresh + +# Remove the default config +rm config.toml + +# Fetch the example config +curl -O https://github.com/lucperkins/hugo-fresh/blob/master/exampleSite/config.yaml + +# Run the site locally +hugo server + +# Open the site in your browser +open http://localhost:1313 +``` \ No newline at end of file