commit 2363ca23146609703ce6233a5fa95024daadc5f5
parent 45b69c2ec85bbec8fac98c9fd32b4764f1f50786
Author: Ryan Wolf <rwolf@borderstylo.com>
Date: Sun, 28 Feb 2010 19:24:29 -0800
added summary
Diffstat:
1 file changed, 14 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
@@ -1,7 +1,13 @@
Designer Decimal
====
-TODO: summary
+I'm fairly certain I got this idea from a story on Reddit, but between writing this and moving it to github, the ephemera machine that is the internet has devoured the original source. If you happen to know the source, please let me know.
+
+To create the designer decimal of a string, convert each character to [ASCII](http://en.wikipedia.org/wiki/ASCII) with enough leading zeros to take of three characters ('A' becomes '065', etc). Add a leading '1.' and a trailing ['004'](http://en.wikipedia.org/wiki/End-of-transmission_character). The result is a decimal encoding of your string, which the original article had the clever name for "Desinger Decimal."
+
+This project does the boring encoding bit for you. Since I was bummed that the results are so long, it also finds a rational approximation which may be more suitable for sticking on business cards.
+
+My first few attempts were incredible slow to converge on a rational approximations, and I had a lot of fun researching better methods.
Usage
-----
@@ -10,11 +16,14 @@ TODO: sample input/output
Attribution
-----
-* John Kennedy, "Algorithm to Convert a Decimal to a Fraction" <http://homepage.smc.edu/kennedy_john/DEC2FRAC.PDF>
- For describing a performant rational approximation algorithm.
+
+* ["Algorithm to Convert a Decimal to a Fraction"](http://homepage.smc.edu/kennedy_john/DEC2FRAC.PDF) by John Kennedy, for describing a performant rational approximation algorithm.
License
-----
-designerdecimal is associated with CC0.
-To the extent possible under law, the person who associated CC0 with this work has waived all copyright and related or neighboring rights to this work. See http://creativecommons.org/publicdomain/zero/1.0/ for more details.
+Designer Decimal is associated with CC0.
+
+To the extent possible under law, the person who associated CC0 with this work has waived all copyright and related or neighboring rights to this work.
+
+See http://creativecommons.org/publicdomain/zero/1.0/ for more details.
