readme update

astocko · Oct 29, 2016 · 7042fca · 7042fca
1 parent 5e15bb4
commit 7042fca
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,9 @@
+# xorshift
+
+Rust crate implementing the splitmix64, xoroshiro128+, xorshift128+, and xorshift1024* PRNGs. Derived from their respective public-domain C implementations.
+
+See [COPYRIGHT](COPYRIGHT) for details.
+
+# algorithms
+
+Please see [http:https://xoroshiro.di.unimi.it](http:https://xoroshiro.di.unimi.it/) for an overview of the PRNGs and their preferred use cases. For parallel simulations, xorshift1024* is recommended, otherwise xoroshiro128+. splitmix64 is convenient for seeding PRNG states.