Update README template and updated README files (#130)

exercism · Jan 17, 2019 · 7658402 · 7658402
1 parent 659bc91
commit 7658402
Show file tree

Hide file tree

Showing 26 changed files with 39 additions and 24 deletions.
diff --git a/config/exercise_readme.go.tmpl b/config/exercise_readme.go.tmpl
@@ -31,4 +31,5 @@ Once you get a test passing, you can unskip the next one by changing `pending` t
 {{ . }}
 {{ end }}
 ## Submitting Incomplete Solutions
+
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
diff --git a/exercises/acronym/README.md b/exercises/acronym/README.md
@@ -34,4 +34,5 @@ Once you get a test passing, you can unskip the next one by changing `pending` t
 Julien Vanier [https://github.com/monkbroc](https://github.com/monkbroc)
 
 ## Submitting Incomplete Solutions
+
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
diff --git a/exercises/anagram/README.md b/exercises/anagram/README.md
@@ -33,4 +33,5 @@ Once you get a test passing, you can unskip the next one by changing `pending` t
 Inspired by the Extreme Startup game [https://github.com/rchatley/extreme_startup](https://github.com/rchatley/extreme_startup)
 
 ## Submitting Incomplete Solutions
+
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
diff --git a/exercises/armstrong-numbers/README.md b/exercises/armstrong-numbers/README.md
@@ -38,4 +38,5 @@ Once you get a test passing, you can unskip the next one by changing `pending` t
 Wikipedia [https://en.wikipedia.org/wiki/Narcissistic_number](https://en.wikipedia.org/wiki/Narcissistic_number)
 
 ## Submitting Incomplete Solutions
+
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
diff --git a/exercises/atbash-cipher/README.md b/exercises/atbash-cipher/README.md
@@ -55,4 +55,5 @@ Once you get a test passing, you can unskip the next one by changing `pending` t
 Wikipedia [http://en.wikipedia.org/wiki/Atbash](http://en.wikipedia.org/wiki/Atbash)
 
 ## Submitting Incomplete Solutions
+
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
diff --git a/exercises/binary-search-tree/README.md b/exercises/binary-search-tree/README.md
@@ -80,4 +80,5 @@ Once you get a test passing, you can unskip the next one by changing `pending` t
 Josh Cheek [https://twitter.com/josh_cheek](https://twitter.com/josh_cheek)
 
 ## Submitting Incomplete Solutions
+
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
diff --git a/exercises/binary/README.md b/exercises/binary/README.md
@@ -57,4 +57,5 @@ Once you get a test passing, you can unskip the next one by changing `pending` t
 All of Computer Science [http://www.wolframalpha.com/input/?i=binary&a=*C.binary-_*MathWorld-](http://www.wolframalpha.com/input/?i=binary&a=*C.binary-_*MathWorld-)
 
 ## Submitting Incomplete Solutions
+
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
diff --git a/exercises/bob/README.md b/exercises/bob/README.md
@@ -42,4 +42,5 @@ Once you get a test passing, you can unskip the next one by changing `pending` t
 Inspired by the 'Deaf Grandma' exercise in Chris Pine's Learn to Program tutorial. [http://pine.fm/LearnToProgram/?Chapter=06](http://pine.fm/LearnToProgram/?Chapter=06)
 
 ## Submitting Incomplete Solutions
+
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
diff --git a/exercises/bracket-push/README.md b/exercises/bracket-push/README.md
@@ -31,4 +31,5 @@ Once you get a test passing, you can unskip the next one by changing `pending` t
 Ginna Baker
 
 ## Submitting Incomplete Solutions
+
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
diff --git a/exercises/difference-of-squares/README.md b/exercises/difference-of-squares/README.md
@@ -12,6 +12,10 @@ Hence the difference between the square of the sum of the first
 ten natural numbers and the sum of the squares of the first ten
 natural numbers is 3025 - 385 = 2640.
 
+You are not expected to discover an efficient solution to this yourself from
+first principles; research is allowed, indeed, encouraged. Finding the best
+algorithm for the problem is a key skill in software engineering.
+
 ## Setup
 
 Follow the setup instructions for Crystal here:
@@ -39,4 +43,5 @@ Once you get a test passing, you can unskip the next one by changing `pending` t
 Problem 6 at Project Euler [http://projecteuler.net/problem=6](http://projecteuler.net/problem=6)
 
 ## Submitting Incomplete Solutions
+
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
diff --git a/exercises/flatten-array/README.md b/exercises/flatten-array/README.md
@@ -37,4 +37,5 @@ Once you get a test passing, you can unskip the next one by changing `pending` t
 Interview Question [https://reference.wolfram.com/language/ref/Flatten.html](https://reference.wolfram.com/language/ref/Flatten.html)
 
 ## Submitting Incomplete Solutions
+
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
diff --git a/exercises/forth/README.md b/exercises/forth/README.md
@@ -48,4 +48,5 @@ In each test suite all but the first test have been skipped.
 Once you get a test passing, you can unskip the next one by changing `pending` to `it`.
 
 ## Submitting Incomplete Solutions
+
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
diff --git a/exercises/gigasecond/README.md b/exercises/gigasecond/README.md
@@ -1,6 +1,7 @@
 # Gigasecond
 
-Calculate the moment when someone has lived for 10^9 seconds.
+Given a moment, determine the moment that would be after a gigasecond
+has passed.
 
 A gigasecond is 10^9 (1,000,000,000) seconds.
 
@@ -31,4 +32,5 @@ Once you get a test passing, you can unskip the next one by changing `pending` t
 Chapter 9 in Chris Pine's online Learn to Program tutorial. [http://pine.fm/LearnToProgram/?Chapter=09](http://pine.fm/LearnToProgram/?Chapter=09)
 
 ## Submitting Incomplete Solutions
+
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
diff --git a/exercises/hamming/README.md b/exercises/hamming/README.md
@@ -1,33 +1,20 @@
 # Hamming
 
-Calculate the Hamming difference between two DNA strands.
+Calculate the Hamming Distance between two DNA strands.
 
-A mutation is simply a mistake that occurs during the creation or
-copying of a nucleic acid, in particular DNA. Because nucleic acids are
-vital to cellular functions, mutations tend to cause a ripple effect
-throughout the cell. Although mutations are technically mistakes, a very
-rare mutation may equip the cell with a beneficial attribute. In fact,
-the macro effects of evolution are attributable by the accumulated
-result of beneficial microscopic mutations over many generations.
+Your body is made up of cells that contain DNA. Those cells regularly wear out and need replacing, which they achieve by dividing into daughter cells. In fact, the average human body experiences about 10 quadrillion cell divisions in a lifetime!
 
-The simplest and most common type of nucleic acid mutation is a point
-mutation, which replaces one base with another at a single nucleotide.
+When cells divide, their DNA replicates too. Sometimes during this process mistakes happen and single pieces of DNA get encoded with the incorrect information. If we compare two strands of DNA and count the differences between them we can see how many mistakes occurred. This is known as the "Hamming Distance".
 
-By counting the number of differences between two homologous DNA strands
-taken from different genomes with a common ancestor, we get a measure of
-the minimum number of point mutations that could have occurred on the
-evolutionary path between the two strands.
-
-This is called the 'Hamming distance'.
-
-It is found by comparing two DNA strands and counting how many of the
-nucleotides are different from their equivalent in the other string.
+We read DNA using the letters C,A,G and T. Two strands might look like this:
 
     GAGCCTACTAACGGGAT
     CATCGTAATGACGGCCT
     ^ ^ ^  ^ ^    ^^
 
-The Hamming distance between these two DNA strands is 7.
+They have 7 differences, and therefore the Hamming Distance is 7.
+
+The Hamming Distance is useful for lots of things in science, not just biology, so it's a nice phrase to be familiar with :)
 
 # Implementation notes
 
@@ -63,4 +50,5 @@ Once you get a test passing, you can unskip the next one by changing `pending` t
 The Calculating Point Mutations problem at Rosalind [http://rosalind.info/problems/hamm/](http://rosalind.info/problems/hamm/)
 
 ## Submitting Incomplete Solutions
+
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
diff --git a/exercises/hello-world/README.md b/exercises/hello-world/README.md
@@ -75,4 +75,5 @@ Once you get a test passing, you can unskip the next one by changing `pending` t
 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.
diff --git a/exercises/largest-series-product/README.md b/exercises/largest-series-product/README.md
@@ -40,4 +40,5 @@ Once you get a test passing, you can unskip the next one by changing `pending` t
 A variation on Problem 8 at Project Euler [http://projecteuler.net/problem=8](http://projecteuler.net/problem=8)
 
 ## Submitting Incomplete Solutions
+
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
diff --git a/exercises/leap/README.md b/exercises/leap/README.md
@@ -13,9 +13,6 @@ on every year that is evenly divisible by 4
 For example, 1997 is not a leap year, but 1996 is.  1900 is not a leap
 year, but 2000 is.
 
-If your language provides a method in the standard library that does
-this look-up, pretend it doesn't exist and implement it yourself.
-
 ## Notes
 
 Though our exercise adopts some very simple rules, there is more to
@@ -53,4 +50,5 @@ Once you get a test passing, you can unskip the next one by changing `pending` t
 JavaRanch Cattle Drive, exercise 3 [http://www.javaranch.com/leap.jsp](http://www.javaranch.com/leap.jsp)
 
 ## Submitting Incomplete Solutions
+
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
diff --git a/exercises/pangram/README.md b/exercises/pangram/README.md
@@ -35,4 +35,5 @@ Once you get a test passing, you can unskip the next one by changing `pending` t
 Wikipedia [https://en.wikipedia.org/wiki/Pangram](https://en.wikipedia.org/wiki/Pangram)
 
 ## Submitting Incomplete Solutions
+
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
diff --git a/exercises/pascals-triangle/README.md b/exercises/pascals-triangle/README.md
@@ -41,4 +41,5 @@ Once you get a test passing, you can unskip the next one by changing `pending` t
 Pascal's Triangle at Wolfram Math World [http://mathworld.wolfram.com/PascalsTriangle.html](http://mathworld.wolfram.com/PascalsTriangle.html)
 
 ## Submitting Incomplete Solutions
+
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
diff --git a/exercises/raindrops/README.md b/exercises/raindrops/README.md
@@ -44,4 +44,5 @@ Once you get a test passing, you can unskip the next one by changing `pending` t
 A variation on a famous interview question intended to weed out potential candidates. [http://jumpstartlab.com](http://jumpstartlab.com)
 
 ## Submitting Incomplete Solutions
+
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
diff --git a/exercises/react/README.md b/exercises/react/README.md
@@ -38,4 +38,5 @@ In each test suite all but the first test have been skipped.
 Once you get a test passing, you can unskip the next one by changing `pending` to `it`.
 
 ## Submitting Incomplete Solutions
+
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
diff --git a/exercises/rna-transcription/README.md b/exercises/rna-transcription/README.md
@@ -45,4 +45,5 @@ Once you get a test passing, you can unskip the next one by changing `pending` t
 Hyperphysics [http://hyperphysics.phy-astr.gsu.edu/hbase/Organic/transcription.html](http://hyperphysics.phy-astr.gsu.edu/hbase/Organic/transcription.html)
 
 ## Submitting Incomplete Solutions
+
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
diff --git a/exercises/roman-numerals/README.md b/exercises/roman-numerals/README.md
@@ -69,4 +69,5 @@ Once you get a test passing, you can unskip the next one by changing `pending` t
 The Roman Numeral Kata [http://codingdojo.org/cgi-bin/index.pl?KataRomanNumerals](http://codingdojo.org/cgi-bin/index.pl?KataRomanNumerals)
 
 ## Submitting Incomplete Solutions
+
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
diff --git a/exercises/run-length-encoding/README.md b/exercises/run-length-encoding/README.md
@@ -50,4 +50,5 @@ Once you get a test passing, you can unskip the next one by changing `pending` t
 Wikipedia [https://en.wikipedia.org/wiki/Run-length_encoding](https://en.wikipedia.org/wiki/Run-length_encoding)
 
 ## Submitting Incomplete Solutions
+
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
diff --git a/exercises/sieve/README.md b/exercises/sieve/README.md
@@ -56,4 +56,5 @@ Once you get a test passing, you can unskip the next one by changing `pending` t
 Sieve of Eratosthenes at Wikipedia [http://en.wikipedia.org/wiki/Sieve_of_Eratosthenes](http://en.wikipedia.org/wiki/Sieve_of_Eratosthenes)
 
 ## Submitting Incomplete Solutions
+
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
diff --git a/exercises/triangle/README.md b/exercises/triangle/README.md
@@ -49,4 +49,5 @@ Once you get a test passing, you can unskip the next one by changing `pending` t
 The Ruby Koans triangle project, parts 1 & 2 [http://rubykoans.com](http://rubykoans.com)
 
 ## Submitting Incomplete Solutions
+
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.