From: Ian Kelling Date: Wed, 2 Jul 2014 03:10:42 +0000 (-0700) Subject: minor doc update X-Git-Url: https://iankelling.org/git/?a=commitdiff_plain;h=1436280b8cc84e31cf46535611b5cf62df92459b;p=spray minor doc update --- diff --git a/Readme.org b/Readme.org index fe15942..334b33a 100644 --- a/Readme.org +++ b/Readme.org @@ -99,7 +99,7 @@ You may customize spray by modifying following items: ** Algorithm details *** Why? -Based on a quick count, similar programs are implemented in 6 languages, 9 platforms and 15+ projects. The core algorithm is choosing a word, an accent character and an interval to display it, and how to do that best is quite important. However, how exactly each project implements that algorithm is generally buried in unrelated code, and mostly undocumented. It is extremely difficult and time consuming to figure out the exact algorithm and differences between them for each project, and I don't think it's hardly ever been done. This sucks. Users would like to know so they can pick one. Developers would like to know so that they can improve their implementation of the algorithm. +Based on a quick count, similar programs are implemented in 6 languages, 9 platforms and 11+ projects. The core algorithm is choosing a word, an accent character and an interval to display it, and how to do that best is quite important. However, how exactly each project implements that algorithm is generally buried in unrelated code, and mostly undocumented. It is extremely difficult and time consuming to figure out the exact algorithm and differences between them for each project, and I don't think it's hardly ever been done. This sucks. Users would like to know so they can pick one. Developers would like to know so that they can improve their implementation of the algorithm. So, I am opening a bug on every project I find, asking them to document what file and function(s) their algorithm is implemented in, and preferably to document it in english as well. The following is an example.