From 41143bbe9790bb678a02d665499d9e77a002f119 Mon Sep 17 00:00:00 2001
From: Antonio Augusto Alves Junior <aalvesju@gmail.com>
Date: Tue, 30 Mar 2021 21:42:32 +0200
Subject: [PATCH] Update README.md
---
README.md | 70 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 69 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index a304608..99a07ee 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,71 @@
# RandomIterator
-Iterator library for lazy calculation and parallel access of counter-based random numbers.
\ No newline at end of file
+Table of Contents
+=================
+
+ * [What is it?](#what-is-it)
+ * [Main features](#main-features)
+ * [The Latest Version](#the-latest-version)
+ * [Documentation](#documentation)
+ * [Reference manual](#reference-manual)
+ * [Users guide](#users-guide)
+ * [Installation and requirements](#installation-and-requirements)
+ * [Examples](#examples)
+ * [Licensing](#licensing)
+ * [Contact the developers](#contact-the-developers)
+ * [Author](#author)
+ * [Acknowledgement](#acknowledgement)
+
+--------------------------------------
+
+## What is it?
+
+RandomIterator is a small library providing iterators pointing to streams of pseudorandom numbers.
+The library deploys lazy-evaluation and is intented for usage on multi-thread calculations.
+
+## Main features
+
+1. Five primary generators: Philox, ARS and Threefry from [Random123](https://ieeexplore.ieee.org/abstract/document/6114424) and Squares3 and Squares4, which are natively implemented.
+2. Completly thread-safe.
+3. Compatibility with all C++ distributions defined in the standard library.
+4. For each seed, the ```random_iterator::Stream<Distribution, Engine>``` manages up to $`{2}^{32}`$ streams, with length $`{2}^{64}`$.
+
+## The Latest Version
+
+Documentation
+-------------
+
+### Reference manual
+
+The complete and updated [Doxygen](http://www.doxygen.org/) source code documentation in HTML format is available at the
+[Reference documentation]( ) web-page.
+It is also possible to browse the documentation by class, file or name using the links:
+
+1.[classes]( )
+
+2.[files]( )
+
+3.[names]( )
+
+
+### User's guide
+
+The RandomIterator User's Guide is available in the following formats:
+
+* [HTML]( )
+* [PDF]( )
+* [EPUB]( )
+
+
+### Examples:
+
+### Iterating over a stream
+
+```cpp
+
+
+```
+
+## Installation and requirements
+
+##
--
GitLab