diff --git a/README.md b/README.md deleted file mode 100644 index 4753cc2..0000000 --- a/README.md +++ /dev/null @@ -1,36 +0,0 @@ -# random - -FIXME: description - -## Installation - -Download from http://example.com/FIXME. - -## Usage - -FIXME: explanation - - $ java -jar random-0.1.0-standalone.jar [args] - -## Options - -FIXME: listing of options this app accepts. - -## Examples - -... - -### Bugs - -... - -### Any Other Sections -### That You Think -### Might be Useful - -## License - -Copyright © 2016 FIXME - -Distributed under the Eclipse Public License either version 1.0 or (at -your option) any later version. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..88a3c1c --- /dev/null +++ b/README.rst @@ -0,0 +1,42 @@ +====== +random +====== + +A pure clojure random library. + +----------- +description +----------- + +This project is a pure clojure random number library that has goals. + +#. Written in pure clojure +#. Functional; a seed should be the input of every functions +#. Use a very good pseudo random number generator algorithm +#. Thread Safe + + +--------- +Algorithm +--------- +The algorithms are translation of Go's "`math/rand`_" package. It totally +makes sense to use Go's random number generator has it has been implemented +by `Ken Thompson`_ and has been used and verified by many talented programmers. +Hence, we can be sure the algorithm is not totally wrong and has a decent speed. + +.. _math/rand: https://golang.org/pkg/math/rand/ +.. _Ken Thompson: https://en.wikipedia.org/wiki/Ken_Thompson + +------------ +performances +------------ +The performance sucks! The java random number generator is many time faster. +But, if the bottle of your application is the random number generator... bravo! +That has never happend to me. + + +----- +Usage +----- +The usage idea is to generate a *state* from a seed. The seed is an integer +and the state an atom. diff --git a/doc/logo.svg b/doc/logo.svg new file mode 100644 index 0000000..b97fd73 --- /dev/null +++ b/doc/logo.svg @@ -0,0 +1,32 @@ + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file