Skip to content

Commit

Permalink
Merge pull request #18 from exercism/generate-readme
Browse files Browse the repository at this point in the history
Generate static exercise README templates
  • Loading branch information
Katrina Owen authored Jul 29, 2017
2 parents d266770 + 80f2c72 commit 9f30dee
Show file tree
Hide file tree
Showing 4 changed files with 143 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.
45 changes: 45 additions & 0 deletions exercises/hello-world/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Hello World

The classical introductory exercise. Just say "Hello, World!".

["Hello, World!"](http://en.wikipedia.org/wiki/%22Hello,_world!%22_program) is
the traditional first program for beginning programming in a new language
or environment.

The objectives are simple:

- Write a function that returns the string "Hello, World!".
- Run the test suite and make sure that it succeeds.
- Submit your solution and check it at the website.

If everything goes well, you will be ready to fetch your first real exercise.

## Getting Started

For installation and learning resources, refer to the
[exercism help page](http://exercism.io/languages/coq).

## Checking the solution (testing everything)

To see if your solution works you just need to compile every file.

```bash
coqc *.v
```

There is no additional testing step needed as we can offload all testing to the type checker!

## Feedback, Issues, Pull Requests

The [exercism/coq](https://github.com/exercism/coq) repository on
GitHub is the home for all of the Coq exercises.

If you have feedback about an exercise, or want to help implementing a new
one, head over there and create an issue. We'll do our best to help you!

## Source

This is an exercise to introduce users to using Exercism [http://en.wikipedia.org/wiki/%22Hello,_world!%22_program](http://en.wikipedia.org/wiki/%22Hello,_world!%22_program)

## Submitting Incomplete Solutions
It's possible to submit an incomplete solution so you can see how others have completed the exercise.
49 changes: 49 additions & 0 deletions exercises/rna-transcription/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Rna Transcription

Given a DNA strand, return its RNA complement (per RNA transcription).

Both DNA and RNA strands are a sequence of nucleotides.

The four nucleotides found in DNA are adenine (**A**), cytosine (**C**),
guanine (**G**) and thymine (**T**).

The four nucleotides found in RNA are adenine (**A**), cytosine (**C**),
guanine (**G**) and uracil (**U**).

Given a DNA strand, its transcribed RNA strand is formed by replacing
each nucleotide with its complement:

* `G` -> `C`
* `C` -> `G`
* `T` -> `A`
* `A` -> `U`

## Getting Started

For installation and learning resources, refer to the
[exercism help page](http://exercism.io/languages/coq).

## Checking the solution (testing everything)

To see if your solution works you just need to compile every file.

```bash
coqc *.v
```

There is no additional testing step needed as we can offload all testing to the type checker!

## Feedback, Issues, Pull Requests

The [exercism/coq](https://github.com/exercism/coq) repository on
GitHub is the home for all of the Coq exercises.

If you have feedback about an exercise, or want to help implementing a new
one, head over there and create an issue. We'll do our best to help you!

## Source

Rosalind [http://rosalind.info/problems/rna](http://rosalind.info/problems/rna)

## Submitting Incomplete Solutions
It's possible to submit an incomplete solution so you can see how others have completed the exercise.
33 changes: 33 additions & 0 deletions exercises/tautology/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Tautology

Let us start by proving something we already know is true.

## Getting Started

For installation and learning resources, refer to the
[exercism help page](http://exercism.io/languages/coq).

## Checking the solution (testing everything)

To see if your solution works you just need to compile every file.

```bash
coqc *.v
```

There is no additional testing step needed as we can offload all testing to the type checker!

## Feedback, Issues, Pull Requests

The [exercism/coq](https://github.com/exercism/coq) repository on
GitHub is the home for all of the Coq exercises.

If you have feedback about an exercise, or want to help implementing a new
one, head over there and create an issue. We'll do our best to help you!

## Source

Coq classics

## 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 9f30dee

Please sign in to comment.