Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/seanlane/gochowdown.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSean Lane <git@sean.lane.sh>2019-01-22 21:27:25 +0300
committerSean Lane <git@sean.lane.sh>2019-01-22 21:27:25 +0300
commiteca6bf9214fde48449d2d73cf6eda2ae93670a3e (patch)
tree113be6985b88b781d029b166079383485f4cdf57
parent68cbcd72042bc106cf103b7702cfcc4ab2160b5b (diff)
Add screenshot to readme
-rw-r--r--README.md16
1 files changed, 14 insertions, 2 deletions
diff --git a/README.md b/README.md
index 4c31ea3..4d083f5 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,30 @@
+# GoChowdown
+
A theme for [Hugo](https://gohugo.io/) based on the [Chowdown](https://github.com/clarklab/chowdown) theme for Jekyll
+<p align="center">
+ <img src="https://raw.githubusercontent.com/seanlane/gochowdown/master/images/screenshot.png" />
+</p>
+
## Quick Start
1. Add the repository into your Hugo Project repository as a submodule, `git submodule add https://github.com/seanlane/gochowdown.git themes/gochowdown`.
2. Configure your `config.toml` or `config.yaml`.
3. Build your site with `hugo serve` and see the result at `http://localhost:1313/`.
-## Add a new recipe draft
+## Using this theme
+
+Similarly to how the original Chowdown theme for Jekyll was organized, this theme adds two sections, recipes and components. The primary section you'll want to use is the recipes, as they form the panel listing on the front page, as well as most of the content. The components section is for recipes that form subcomponents of a recipe, allowing for a recipe to call on several components, and different recipes to reuse the same component, if desired.
+
+Note that this is a work in progress, so things may be broken or change in the future. Feel free to contribute or offer suggestions.
+
+### Add a new recipe draft
1. Navigate to the root directory of your website folder within a terminal
2. Type `hugo new --kind recipe-bundle recipes/name-of-your-new-recipe-here`, replacing `name-of-your-new-recipe-here` with the name of your recipe
- Note that the default template (archetype in Hugo vernacular) will replace the hypens in the provided name with spaces as the title and capitalize the first letter of each word. For example, if I were to enter the command `hugo new --kind recipe-bundle recipes/hot-dog`, I would find a new folder at `content/recipes/hot-dog`, and the title within the `index.md` file in that folder would be `Hot Dog`.
-## Add a new recipe with components
+### Add a new recipe with components
Similar to above, but instead of adding the recipes to the `content/recipes` directory, add the individual components to the `content/components` directory. Then add a new recipe as you normally would, and replace the instructions list with a components list, using the title (aka name) of the recipe, and modify the directions section as needed.