update documentation and release notes

epiqc · Feb 5, 2018 · 861c8b6 · 861c8b6
1 parent aeb4e3a
commit 861c8b6
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -15,13 +15,9 @@ Release Information
 Current Release
 ---------------
 
-ScaffCC is currently in an *alpha* release. Specifically, the release details are:
+-   Version 3.1
 
--   Version 3.0
-
--   Release Date: August, 2017
-
--   Release Note: The current version is still an alpha release. Multiple new features are in active developement. For instance, .qasmf formart conforming to standardized QASM and optimization to parallel scheduler are expected to be included in the near term.
+-   Release Date: February, 2018
 
 Supported Operating Systems
 ---------------------------
@@ -213,6 +209,7 @@ To see a list of compiler options which can be passed as flags, run:
         -r   Generate resource estimate (default)
         -q   Generate QASM
         -f   Generate flattened QASM
+        -b   Generate OpenQASM
         -R   Disable rotation decomposition
         -T   Disable Toffoli decomposition
         -l   Levels of recursion to run (default=1)

diff --git a/changelog.txt b/changelog.txt
@@ -1,6 +1,6 @@
 2018-02-06:
-	Release version -v4.0
-  Migrated to LLVM v6.0.
+	Release version -v3.1
+  Added ability to output OpenQASM (via -b flag for scaffold.sh).
   Released Braidflash v2.0, with improved simulation of magic state distillation overheads, 
   including different distillation protocols and different factory layouts.
   Fixed bug in braidflash generating machine-dependent results due to uninitialized variable.

diff --git a/docs/Documentation.pdf b/docs/Documentation.pdf
diff --git a/docs/Documentation.tex b/docs/Documentation.tex
@@ -58,7 +58,7 @@
 \author{Ali JavadiAbhari, Adam Holmes, Shruti Patil, Jeff Heckey, Daniel Kudrow,\\ Pranav Gokhale, David Noursi, Lee Ehudin, \\
 Yongshan Ding, Xin-Chuan Ryan Wu, Yunong Shi}
 
-\date{August 2017}
+\date{February 2018}
 
 
 

diff --git a/docs/ch-apps/chapter-apps.aux b/docs/ch-apps/chapter-apps.aux
@@ -24,15 +24,15 @@
 \setcounter{part}{0}
 \setcounter{chapter}{4}
 \setcounter{section}{0}
-\setcounter{subsection}{0}
+\setcounter{subsection}{7}
 \setcounter{subsubsection}{0}
 \setcounter{paragraph}{0}
 \setcounter{subparagraph}{0}
 \setcounter{figure}{0}
 \setcounter{table}{0}
 \setcounter{ContinuedFloat}{0}
 \setcounter{parentequation}{0}
-\setcounter{lstnumber}{19}
+\setcounter{lstnumber}{20}
 \setcounter{Item}{27}
 \setcounter{Hfootnote}{0}
 \setcounter{bookmark@seq@number}{22}

diff --git a/docs/ch-release/chapter-release.tex b/docs/ch-release/chapter-release.tex
@@ -2,9 +2,8 @@ \chapter{Release Information}\label{ch:release}
 \section{Current Release}
     The current release of ScaffCC is:
     \begin{itemize}
-        \item Version 3.0
-        \item Alpha
-        \item Release Date: August 6, 2017
+        \item Version 3.1
+        \item Release Date: February 4, 2018
     \end{itemize}
 \section{Supported Operating Systems}
     ScaffCC currently offers support for the following operating systems:

diff --git a/docs/ch-usage/chapter-usage.aux b/docs/ch-usage/chapter-usage.aux
@@ -39,7 +39,7 @@
 \setcounter{table}{0}
 \setcounter{ContinuedFloat}{0}
 \setcounter{parentequation}{0}
-\setcounter{lstnumber}{19}
+\setcounter{lstnumber}{20}
 \setcounter{Item}{17}
 \setcounter{Hfootnote}{0}
 \setcounter{bookmark@seq@number}{21}

diff --git a/docs/ch-usage/chapter-usage.tex b/docs/ch-usage/chapter-usage.tex
@@ -23,6 +23,7 @@ \section{Compiler Options}
     -r   Generate resource estimate (default)
     -q   Generate QASM
     -f   Generate flattened QASM
+    -b   Generate OpenQASM
     -R   Disable rotation decomposition
     -T   Disable Toffoli decomposition
     -l   Levels of recursion to run (default=1)