summaryrefslogtreecommitdiffstats
path: root/README
AgeCommit message (Collapse)Author
2020-02-26doc: convert standard project docs to markdownDr. Matthias St. Pierre
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 <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/10545)
2019-10-18Remove the version number in READMERichard Levitte
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 <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/10205)
2018-12-06Change license to the Apache License v2.0Richard Levitte
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 <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/7764)
2018-12-06Switch to MAJOR.MINOR.PATCH versioning and version 3.0.0-devRichard Levitte
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 <tjh@openssl.org> Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/7724)
2018-09-11The next version in master is at least 1.1.2, not 1.1.1xRichard Levitte
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 <Matthias.St.Pierre@ncp-e.com> (Merged from https://github.com/openssl/openssl/pull/7180)
2018-09-11Prepare for 1.1.1a-devMatt Caswell
Reviewed-by: Richard Levitte <levitte@openssl.org>
2018-09-11Prepare for 1.1.1 releaseOpenSSL_1_1_1Matt Caswell
Reviewed-by: Richard Levitte <levitte@openssl.org>
2018-08-21Prepare for 1.1.1-pre10-devMatt Caswell
Reviewed-by: Tim Hudson <tjh@openssl.org>
2018-08-21Prepare for 1.1.1-pre9 releaseOpenSSL_1_1_1-pre9Matt Caswell
Reviewed-by: Tim Hudson <tjh@openssl.org>
2018-06-20Prepare for 1.1.1-pre9-devMatt Caswell
Reviewed-by: Richard Levitte <levitte@openssl.org>
2018-06-20Prepare for 1.1.1-pre8 releaseOpenSSL_1_1_1-pre8Matt Caswell
Reviewed-by: Richard Levitte <levitte@openssl.org>
2018-05-29Prepare for 1.1.1-pre8-devMatt Caswell
Reviewed-by: Richard Levitte <levitte@openssl.org>
2018-05-29Prepare for 1.1.1-pre7 releaseOpenSSL_1_1_1-pre7Matt Caswell
Reviewed-by: Richard Levitte <levitte@openssl.org>
2018-05-01Prepare for 1.1.1-pre7-devMatt Caswell
Reviewed-by: Rich Salz <rsalz@openssl.org>
2018-05-01Prepare for 1.1.1-pre6 releaseOpenSSL_1_1_1-pre6Matt Caswell
Reviewed-by: Rich Salz <rsalz@openssl.org>
2018-04-17Prepare for 1.1.1-pre6-devRichard Levitte
Reviewed-by: Matt Caswell <matt@openssl.org>
2018-04-17Prepare for 1.1.1-pre5 releaseOpenSSL_1_1_1-pre5Richard Levitte
Reviewed-by: Matt Caswell <matt@openssl.org>
2018-04-03Prepare for 1.1.1-pre5-devMatt Caswell
Reviewed-by: Richard Levitte <levitte@openssl.org>
2018-04-03Prepare for 1.1.1-pre4 releaseOpenSSL_1_1_1-pre4Matt Caswell
Reviewed-by: Richard Levitte <levitte@openssl.org>
2018-03-20Prepare for 1.1.1-pre4-devMatt Caswell
Reviewed-by: Richard Levitte <levitte@openssl.org>
2018-03-20Prepare for 1.1.1-pre3 releaseOpenSSL_1_1_1-pre3Matt Caswell
Reviewed-by: Richard Levitte <levitte@openssl.org>
2018-02-27Prepare for 1.1.1-pre3-devMatt Caswell
Reviewed-by: Richard Levitte <levitte@openssl.org>
2018-02-27Prepare for 1.1.1-pre2 releaseOpenSSL_1_1_1-pre2Matt Caswell
Reviewed-by: Richard Levitte <levitte@openssl.org>
2018-02-13Prepare for 1.1.1-pre2-devMatt Caswell
Reviewed-by: Richard Levitte <levitte@openssl.org>
2018-02-13Prepare for 1.1.1-pre1 releaseOpenSSL_1_1_1-pre1Matt Caswell
Reviewed-by: Richard Levitte <levitte@openssl.org>
2018-02-13Update copyright yearMatt Caswell
Reviewed-by: Richard Levitte <levitte@openssl.org>
2018-02-13OpenSSL 1.1.1 is now in pre releaseMatt Caswell
Reviewed-by: Richard Levitte <levitte@openssl.org>
2018-01-29Document the use of configdata.pm as a scriptRichard Levitte
Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/5185)
2017-11-11Many spelling fixes/typo's corrected.Josh Soref
Around 138 distinct errors found and fixed; thanks! Reviewed-by: Kurt Roeckx <kurt@roeckx.be> Reviewed-by: Tim Hudson <tjh@openssl.org> Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/3459)
2016-10-26Fix typo (reported by Matthias St. Pierre)Rich Salz
Reviewed-by: Tim Hudson <tjh@openssl.org>
2016-10-12RT is put out to pastureRich Salz
Reviewed-by: Tim Hudson <tjh@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1702)
2016-08-25Update CHANGES, NEWS, README and opensslv.h on masterRichard Levitte
Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-08-04Prepare for 1.1.0-pre7-devMatt Caswell
Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-08-04Prepare for 1.1.0-pre6 releaseOpenSSL_1_1_0-pre6Matt Caswell
Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-06-22Spelling... and more spellingFdaSilvaYY
Reviewed-by: Kurt Roeckx <kurt@openssl.org> Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1245)
2016-06-03Bring the README file up to dateMatt Caswell
The README file was a little out of date so needed a refresh Reviewed-by: Rich Salz <rsalz@openssl.org> Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-23Slight cleanup of the collection of READMEs, INSTALLs and NOTESRichard Levitte
README is a fairly independent document, and so is INSTALL. NOTES are merely addendums to INSTALL. Therefore , INSTALL.DJGPP and README.PERL get renamed to NOTES.DJGPP and NOTES.PERL. Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-05-23Remove INSTALL.WCE and refs to it.Rich Salz
Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-04-19Prepare for 1.1.0-pre6-devMatt Caswell
Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-04-19Prepare for 1.1.0-pre5 releaseOpenSSL_1_1_0-pre5Matt Caswell
Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-03-17README: small fixupsRichard Levitte
Don't refer to INSTALL files that don't exist any more. Make it clear that the libssl and libcrypto libraries may be named differently on different platforms. Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-03-17Remove Netware and OS/2Rich Salz
Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-03-16Prepare for 1.1.0-pre5-devRichard Levitte
Reviewed-by: Emilia Käsper <emilia@openssl.org>
2016-03-16Prepare for 1.1.0-pre4 releaseOpenSSL_1_1_0-pre4Richard Levitte
Reviewed-by: Emilia Käsper <emilia@openssl.org>
2016-02-15Prepare for 1.1.0-pre4-devRichard Levitte
Reviewed-by: Stephen Henson <steve@openssl.org>
2016-02-15Prepare for 1.1.0-pre3 releaseOpenSSL_1_1_0-pre3Richard Levitte
Reviewed-by: Stephen Henson <steve@openssl.org>
2016-01-27Fix typosZhao Junwang
cryptograpic => cryptographic Signed-off-by: Rich Salz <rsalz@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org>
2016-01-15Update Windows installation instructionsMatt Caswell
The windows installation instructions were very out of date. Substantial update to the text. Remove a lot of historical stuff that isn't relevant any more, and merge the win64 and win32 instructions into one file. Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-01-14Prepare for 1.1.0-pre3-devRichard Levitte
Reviewed-by: Matt Caswell <matt@openssl.org>
2016-01-14Prepare for 1.1.0-pre2 releaseOpenSSL_1_1_0-pre2Richard Levitte
Reviewed-by: Matt Caswell <matt@openssl.org>