openssl/README, branch master

doc: convert standard project docs to markdown

2020-02-26T20:04:38Z

In the first step, we just add the .md extension and move some files around, without changing any content. These changes will occur in the following commits. Reviewed-by: Tomas Mraz (Merged from https://github.com/openssl/openssl/pull/10545)

Remove the version number in README

2019-10-18T10:22:00Z

It's cumbersome to have to edit it at release time, it can't be made a README.in for display reasons (Github won't show it), and having the version number here gives no special benefit. Reviewed-by: Matt Caswell (Merged from https://github.com/openssl/openssl/pull/10205)

Change license to the Apache License v2.0

2018-12-06T12:27:18Z

This applies to the 'master' git branch and OpenSSL version 3.0.0 and up. Pre-3.0.0 versions retain the previous license. The boilerplate will change in increments after this change. Reviewed-by: Matt Caswell (Merged from https://github.com/openssl/openssl/pull/7764)

Switch to MAJOR.MINOR.PATCH versioning and version 3.0.0-dev

2018-12-06T11:24:47Z

We're strictly use version numbers of the form MAJOR.MINOR.PATCH. Letter releases are things of days past. The most central change is that we now express the version number with three macros, one for each part of the version number: OPENSSL_VERSION_MAJOR OPENSSL_VERSION_MINOR OPENSSL_VERSION_PATCH We also provide two additional macros to express pre-release and build metadata information (also specified in semantic versioning): OPENSSL_VERSION_PRE_RELEASE OPENSSL_VERSION_BUILD_METADATA To get the library's idea of all those values, we introduce the following functions: unsigned int OPENSSL_version_major(void); unsigned int OPENSSL_version_minor(void); unsigned int OPENSSL_version_patch(void); const char *OPENSSL_version_pre_release(void); const char *OPENSSL_version_build_metadata(void); Additionally, for shared library versioning (which is out of scope in semantic versioning, but that we still need): OPENSSL_SHLIB_VERSION We also provide a macro that contains the release date. This is not part of the version number, but is extra information that we want to be able to display: OPENSSL_RELEASE_DATE Finally, also provide the following convenience functions: const char *OPENSSL_version_text(void); const char *OPENSSL_version_text_full(void); The following macros and functions are deprecated, and while currently existing for backward compatibility, they are expected to disappear: OPENSSL_VERSION_NUMBER OPENSSL_VERSION_TEXT OPENSSL_VERSION OpenSSL_version_num() OpenSSL_version() Also, this function is introduced to replace OpenSSL_version() for all indexes except for OPENSSL_VERSION: OPENSSL_info() For configuration, the option 'newversion-only' is added to disable all the macros and functions that are mentioned as deprecated above. Reviewed-by: Tim Hudson Reviewed-by: Matthias St. Pierre Reviewed-by: Matt Caswell (Merged from https://github.com/openssl/openssl/pull/7724)

The next version in master is at least 1.1.2, not 1.1.1x

2018-09-11T14:51:38Z

The OMC hasn't yet decided what the next release version will be, but it's at least going to 1.1.2, so we set that value for the moment. Reviewed-by: Matthias St. Pierre (Merged from https://github.com/openssl/openssl/pull/7180)

Prepare for 1.1.1a-dev

2018-09-11T12:49:46Z

Reviewed-by: Richard Levitte

Prepare for 1.1.1 release

2018-09-11T12:48:18Z

Reviewed-by: Richard Levitte

Prepare for 1.1.1-pre10-dev

2018-08-21T12:15:56Z

Reviewed-by: Tim Hudson

Prepare for 1.1.1-pre9 release

2018-08-21T12:14:10Z

Reviewed-by: Tim Hudson

Prepare for 1.1.1-pre9-dev

2018-06-20T14:49:35Z

Reviewed-by: Richard Levitte