From 499a587b5599e66c7673decd892e8fdeea91e254 Mon Sep 17 00:00:00 2001 From: Douglas Stebila Date: Tue, 13 Nov 2018 11:30:09 -0500 Subject: [PATCH] Update for 0.1.0 release --- CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++ RELEASE.md | 6 +++--- configure.ac | 6 +++--- 3 files changed, 38 insertions(+), 6 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..e1f1c60028 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,32 @@ +Contributing to liboqs master branch +==================================== + +liboqs has two branches: "master branch", and "nist-branch". + +liboqs master branch focuses on focuses on selected key encapsulations and signature algorithms. Implementations on this branch must beet certain acceptance criteria. + +liboqs nist-branch focuses on incorporating submissions to the NIST Post-Quantum Cryptography standardization project. It takes a "light touch" approach to incorporation. + +Contributing new algorithms +--------------------------- + +The goals and acceptance criteria for new algorithms on liboqs master branch are stated in the README.md. In particular, our goals are to include high quality implementations for which the contributor aims to help with ongoing maintenance. + +To discuss contributing a new algorithm to liboqs master branch, please contact [Douglas Stebila](https://www.douglas.stebila.ca/research/) or post an issue on GitHub for discussion. + +Additional information about contributing code, including coding conventions, can be found on our [GitHub wiki](https://github.com/open-quantum-safe/liboqs/wiki). + +Contributing enhancements +------------------------- + +Contributions to our existing library are gratefully welcomed. If you find a bug in our code, have some improvements to an algorithm, are interested in getting liboqs to build on a new platform, or want to explore integrating liboqs into a new application, please feel free to contact us on GitHub via an issue or pull request. + +Bug reports +----------- + +Bug reports can be filed as issues on GitHub. Please use the "bug" label. Please indicate which branch of liboqs the issue relates to (master or nist-branch), and what platform was in use (CPU, operating system, compiler). + +License +------- + +liboqs is licensed primarily under the MIT License. Submissions to liboqs master branch must be under the MIT License, a compatible license, or in the public domain. See README.md for details. diff --git a/RELEASE.md b/RELEASE.md index c2315db72a..674e8b82fb 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,5 +1,5 @@ -liboqs master branch version 0.1.0-rc3 -====================================== +liboqs master branch version 0.1.0 +================================== About ----- @@ -19,7 +19,7 @@ This branch of liboqs can be used with the following Open Quantum Safe applicati Release notes ============= -**This is a release candidate for liboqs master, not a final release.**. This release of liboqs master branch was released on TODO. Its release page on GitHub is TODO. +This release of liboqs master branch was released on November 13, 2018. Its release page on GitHub is https://github.com/open-quantum-safe/liboqs/releases/tag/master-0.1.0. What's New ---------- diff --git a/configure.ac b/configure.ac index 9ca2a54f14..f0b6a061ca 100644 --- a/configure.ac +++ b/configure.ac @@ -2,7 +2,7 @@ # Process this file with autoconf to produce a configure script. # Init -AC_INIT([liboqs], [0.1.0-rc3], [https://github.com/open-quantum-safe/liboqs/issues], [liboqs-master], [https://openquantumsafe.org/]) +AC_INIT([liboqs], [0.1.0], [https://github.com/open-quantum-safe/liboqs/issues], [liboqs-master], [https://openquantumsafe.org/]) AM_INIT_AUTOMAKE([subdir-objects no-dependencies]) AM_PROG_LIBTOOL @@ -17,8 +17,8 @@ AM_PROG_LIBTOOL # 1.2.3-rc2 0x10203002 (same as ...rc2-dev) # 1.2.3 0x1020300f # 1.2.3a 0x1020301f -AC_DEFINE([OQS_VERSION_NUMBER],[0x00100003L],[Numeric liboqs version]) -AC_DEFINE([OQS_VERSION_TEXT],["0.1.0 RC3"],[Text liboqs version]) +AC_DEFINE([OQS_VERSION_NUMBER],[0x0010000fL],[Numeric liboqs version]) +AC_DEFINE([OQS_VERSION_TEXT],["0.1.0"],[Text liboqs version]) AC_DEFINE([OQS_MASTER_BRANCH],[],[liboqs branch]) # Configure