v2.0.0 Release Docs Updates

* Doxygen Docs Updates
homenc · Jan 19, 2021 · 0232d60 · 0232d60
1 parent 5fe2a8a
commit 0232d60
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 10 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,9 +1,10 @@
+Release Changes
+===============
+
 HElib 2.0.0, January 2021
 =========================
 (tagged as v2.0.0)
 
-December-January 2021
----------------------
 * Contains API changes that are not backwards compatible with v1.x.x
   * Changes to Context API
   * Must use ContextBuilder to build context

diff --git a/documentation/Doxyfile b/documentation/Doxyfile
@@ -827,12 +827,15 @@ INPUT                  = ./mainpage.dox \
                          ../CONTRIBUTING.md \
                          ../CODE_OF_CONDUCT.md \
                          ../LICENSE.md \
+                         ../CHANGES.md \			 
                          ../INSTALL.md \
                          ../TESTS.md \
+                         ../examples/README.md \
                          ../include/helib \
                          ../src \
                          ../utils \
                          ../misc/psi \
+                         ../CKKS-security.md \
                          ../ISSUES.md
 
 # This tag can be used to specify the character encoding of the source files

diff --git a/documentation/mainpage.dox b/documentation/mainpage.dox
@@ -2,17 +2,19 @@
 @mainpage HElib Documentation
 
 HElib is an open-source (<a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License v2.0</a>) 
-software library that implements homomorphic encryption (HE).
+software library that implements <a href="http://en.wikipedia.org/wiki/Homomorphic_encryption">homomorphic encryption</a> (HE).
 Currently available schemes are the implementations of the
-<a href="http://eprint.iacr.org/2011/277">Brakerski-Gentry-Vaikuntanathan</a>  (BGV) scheme and the Approximate Number 
+<a href="http://eprint.iacr.org/2011/277">Brakerski-Gentry-Vaikuntanathan</a>  (BGV) scheme with bootstrapping and the Approximate Number 
 scheme of <a href="http://eprint.iacr.org/2016/421">Cheon-Kim-Kim-Song</a> (CKKS), along with many
 optimizations to make homomorphic evaluation runs faster, focusing mostly on
 effective use of the <a href="http://eprint.iacr.org/2011/133">Smart-Vercauteren</a> ciphertext packing techniques and
-the <a href="http://eprint.iacr.org/2012/099">Gentry-Halevi-Smart</a> optimizations. 
+the <a href="http://eprint.iacr.org/2012/099">Gentry-Halevi-Smart</a> optimizations.
+
+Please refer to <a href="https://github.com/homenc/HElib/blob/master/CKKS-security.md">CKKS-security.md</a> for the latest discussion on the security of the CKKS scheme implementation in HElib.
 
 Articles that describe some aspects of HElib include:
 
-  - <a href="https://homenc.github.io/HElib/documentation/Design_Document/HElib-design.pdf">HElib Design Principles</a>, Shai Halevi and Victor Shoup, August 2020.
+  - <a href="https://eprint.iacr.org/2020/1481">HElib Design Principles</a>, Shai Halevi and Victor Shoup, November 2020.
   - <a href="http://eprint.iacr.org/2014/106">Algorithms in HElib</a>, Shai Halevi and Victor Shoup, published in <a href="http://www.iacr.org/conferences/crypto2014/">CRYPTO 2014</a>.
   - <a href="http://eprint.iacr.org/2014/873">Bootstrapping for HElib</a>, Shai Halevi and Victor Shoup, <a href="https://www.cosic.esat.kuleuven.be/eurocrypt_2015/">EUROCRYPT 2015</a>.
 
@@ -24,12 +26,11 @@ HElib supports an <b>"assembly language for HE"</b>, providing low-level routine
 (set, add, multiply, shift, etc.), sophisticated automatic noise management,
 improved BGV bootstrapping, multi-threading, and also support for Ptxt (plaintext) 
 objects which mimics the functionality of Ctxt (ciphertext) objects.
-See <a href="https://github.com/homenc/HElib/changes.md">changes.md</a> for more details.
 
-HElib is written in C++14 and uses the <a href="http://www.shoup.net/ntl/">NTL</a> mathematical library.
+HElib is written in C++17 and uses the <a href="http://www.shoup.net/ntl/">NTL</a> mathematical library.
 
 HElib is distributed under the terms of the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License v2.0</a>.  
 
-For code downloads and full installation instructions, visit <a href="https://github.com/homenc/HElib">HElib GitHub Pages</a>.
+For code downloads, full installation instructions, example programs and tutorials, visit <a href="https://github.com/homenc/HElib">HElib GitHub Pages</a>.
 
 **/
diff --git a/examples/README.md b/examples/README.md
@@ -1,4 +1,4 @@
-# Examples
+# Examples and Tutorials
 
 ## Introduction