Skip to content

Commit

Permalink
Update for 0.1.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
dstebila committed Nov 13, 2018
1 parent e3ae7b5 commit 499a587
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 6 deletions.
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
6 changes: 3 additions & 3 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
liboqs master branch version 0.1.0-rc3
======================================
liboqs master branch version 0.1.0
==================================

About
-----
Expand All @@ -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
----------
Expand Down
6 changes: 3 additions & 3 deletions configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit 499a587

Please sign in to comment.