Skip to content

Commit

Permalink
Add exercise README templates
Browse files Browse the repository at this point in the history
We are working towards making exercises stand-alone—that is to say:
no more generating READMEs on the fly.

This will give maintainers more control over each individual exercise
README.

The template uses the Go text/template package, and the default templates
generate the exact same READMEs as we have been generating on the fly.
  • Loading branch information
Katrina Owen committed Jul 16, 2017
1 parent f8c0f2a commit 510c66f
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions config/exercise_readme.go.tmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# {{ .Spec.Name }}

{{ .Spec.Description -}}
{{- with .Hints }}
{{ . }}
{{ end }}
{{- with .TrackInsert }}
{{ . }}
{{ end }}
{{- with .Spec.Credits -}}
## Source

{{ . }}
{{ end }}
## Submitting Incomplete Solutions
It's possible to submit an incomplete solution so you can see how others have completed the exercise.

0 comments on commit 510c66f

Please sign in to comment.