Skip to content

Commit

Permalink
Version 0.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
vsoftco committed Nov 28, 2020
1 parent 0cf85b1 commit 34589fa
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 12 deletions.
2 changes: 1 addition & 1 deletion .travis/install_liboqs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
git clone --branch main --single-branch --depth 1 https://github.com/open-quantum-safe/liboqs
cd liboqs
mkdir build && cd build
cmake -GNinja -DBUILD_SHARED_LIBS=ON ..
cmake -GNinja -DBUILD_SHARED_LIBS=ON -DOQS_BUILD_ONLY_LIB=ON ..
ninja
sudo ninja install
3 changes: 3 additions & 0 deletions CHANGES.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
Version 0.4.0 - November 28, 2020
- Renamed 'master' branch to 'main'

Version 0.3.0 - June 10, 2020
- Removed the Visual Studio solution (since it can be automatically
generated by CMake), as we prefer to use CMake uniformly across all
Expand Down
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
cmake_minimum_required(VERSION 3.2)
project(oqs_cpp VERSION 0.3.0 LANGUAGES CXX)
project(oqs_cpp VERSION 0.4.0 LANGUAGES CXX)

set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
Expand Down
2 changes: 1 addition & 1 deletion Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ PROJECT_NAME = "liboqs-cpp"
# could be handy for archiving the generated documentation or if some version
# control system is used.

PROJECT_NUMBER = 0.3.0
PROJECT_NUMBER = 0.4.0

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
liboqs-cpp: C++ bindings for liboqs
===================================

[![Build status - Linux/macOS](https://api.travis-ci.com/open-quantum-safe/liboqs-cpp.svg?branch=master)](https://travis-ci.com/open-quantum-safe/liboqs-cpp)
[![Build status - Linux/macOS](https://api.travis-ci.com/open-quantum-safe/liboqs-cpp.svg?branch=main)](https://travis-ci.com/open-quantum-safe/liboqs-cpp)
[![Build status - Windows](https://ci.appveyor.com/api/projects/status/v7b5ner85txm8u77?svg=true)](https://ci.appveyor.com/project/vsoftco/liboqs-cpp)

---
Expand Down Expand Up @@ -42,7 +42,7 @@ Support for alternative RNGs is provided by the `include/rand/rand.h` header fil

The wrapper also defines a high resolution timing class, `oqs::Timer<>`.

The examples in the [`examples`](https://github.com/open-quantum-safe/liboqs-cpp/tree/master/examples) directory are self-explanatory and provide more details about the wrapper's API.
The examples in the [`examples`](https://github.com/open-quantum-safe/liboqs-cpp/tree/main/examples) directory are self-explanatory and provide more details about the wrapper's API.

Building on POSIX (Linux/UNIX-like) platforms
---------------------------------------------
Expand Down Expand Up @@ -90,7 +90,7 @@ of course replacing the paths with the ones corresponding to your system.
Documentation
-------------
To generate the full official API documentation in both PDF and HTML formats run
[`doxygen`](http://www.doxygen.nl) on the [`Doxyfile`](https://github.com/open-quantum-safe/liboqs-cpp/blob/master/Doxyfile) file. The tool `dot` from the [`Graphviz`](https://www.graphviz.org) package must be installed (`sudo apt-get install graphviz` in Ubuntu/Debian). Running `doxygen` will generate the
[`doxygen`](http://www.doxygen.nl) on the [`Doxyfile`](https://github.com/open-quantum-safe/liboqs-cpp/blob/main/Doxyfile) file. The tool `dot` from the [`Graphviz`](https://www.graphviz.org) package must be installed (`sudo apt-get install graphviz` in Ubuntu/Debian). Running `doxygen` will generate the
documentation directory `doc` containing both the HTML and LaTeX documentation.

The HTML documentation file will be accessible by opening `doc/html/index.html` with the browser of your choice.
Expand All @@ -112,12 +112,12 @@ We believe that the NIST Post-Quantum Cryptography standardization project is cu

We acknowledge that some parties may want to begin deploying post-quantum cryptography prior to the conclusion of the NIST standardization project. We strongly recommend that any attempts to do make use of so-called **hybrid cryptography**, in which post-quantum public-key algorithms are used alongside traditional public key algorithms (like RSA or elliptic curves) so that the solution is at least no less secure than existing traditional cryptography.

Just like liboqs, liboqs-cpp is provided "as is", without warranty of any kind. See [LICENSE](https://github.com/open-quantum-safe/liboqs-cpp/blob/master/LICENSE) for the full disclaimer.
Just like liboqs, liboqs-cpp is provided "as is", without warranty of any kind. See [LICENSE](https://github.com/open-quantum-safe/liboqs-cpp/blob/main/LICENSE) for the full disclaimer.

License
-------

liboqs-cpp is licensed under the MIT License; see [LICENSE](https://github.com/open-quantum-safe/liboqs-cpp/blob/master/LICENSE) for details.
liboqs-cpp is licensed under the MIT License; see [LICENSE](https://github.com/open-quantum-safe/liboqs-cpp/blob/main/LICENSE) for details.

Team
----
Expand Down
8 changes: 4 additions & 4 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
liboqs-cpp version 0.3.0
liboqs-cpp version 0.4.0
========================

About
Expand All @@ -8,14 +8,14 @@ The **Open Quantum Safe (OQS) project** has the goal of developing and prototypi

**liboqs** is an open source C library for quantum-resistant cryptographic algorithms. See more about liboqs at [https://github.com/open-quantum-safe/liboqs/](https://github.com/open-quantum-safe/liboqs/), including a list of supported algorithms.

**liboqs-cpp** is an open source C++ wrapper for the liboqs C library for quantum-resistant cryptographic algorithms. Details about liboqs-cpp can be found in [README.md](https://github.com/open-quantum-safe/liboqs-cpp/blob/master/README.md). See in particular limitations on intended use.
**liboqs-cpp** is an open source C++ wrapper for the liboqs C library for quantum-resistant cryptographic algorithms. Details about liboqs-cpp can be found in [README.md](https://github.com/open-quantum-safe/liboqs-cpp/blob/main/README.md). See in particular limitations on intended use.

Release notes
=============

This release of liboqs-cpp was released on June 10, 2020. Its release page on GitHub is https://github.com/open-quantum-safe/liboqs-cpp/releases/tag/0.3.0.
This release of liboqs-cpp was released on November 28, 2020. Its release page on GitHub is https://github.com/open-quantum-safe/liboqs-cpp/releases/tag/0.4.0.

What's New
----------

This is the seventh release of liboqs-cpp. For a list of changes see [CHANGES.txt](https://github.com/open-quantum-safe/liboqs-cpp/blob/master/CHANGES.txt).
This is the eight release of liboqs-cpp. For a list of changes see [CHANGES.txt](https://github.com/open-quantum-safe/liboqs-cpp/blob/main/CHANGES.txt).

0 comments on commit 34589fa

Please sign in to comment.