From 8805648969155e5f9662fb1df840f752b258fa57 Mon Sep 17 00:00:00 2001 From: Erik Osterman Date: Sun, 15 Jul 2018 23:19:50 -0700 Subject: [PATCH] Add intro section (#78) * Add intro section * Remove introduction --- README.md | 1 + README.yaml | 4 ++++ templates/README.md | 5 +++++ 3 files changed, 10 insertions(+) diff --git a/README.md b/README.md index 5e12bac3..52e90068 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,7 @@ It's 100% Open Source and licensed under the [APACHE2](LICENSE). *Example of using the `build-harness` to build a docker image* + ## Usage At the top of your `Makefile` add, the following... diff --git a/README.yaml b/README.yaml index 4e730d00..93927077 100644 --- a/README.yaml +++ b/README.yaml @@ -59,6 +59,10 @@ description: |- This `build-harness` is a collection of Makefiles to facilitate building Golang projects, Dockerfiles, Helm charts, and more. It's designed to work with CI/CD systems such as Travis CI, CircleCI and Jenkins. +# Introduction to the project +#introduction: |- +# This is an introduction. + # How to use this project usage: |- At the top of your `Makefile` add, the following... diff --git a/templates/README.md b/templates/README.md index b8333cd4..a38c97c5 100644 --- a/templates/README.md +++ b/templates/README.md @@ -41,6 +41,11 @@ It's 100% Open Source and licensed under the [GNU General Public License](LICENS {{ range $screenshot := (ds "config").screenshots }} {{ printf "![%s](%s)\n*%s*" $screenshot.name $screenshot.url $screenshot.description }}{{ end }} {{ end }} +{{ if has (ds "config") "introduction" }} +## Introduction + +{{ (ds "config").introduction -}} +{{ end }} {{ if has (ds "config") "usage" }} ## Usage