X-Git-Url: https://git.openssl.org/gitweb/?a=blobdiff_plain;f=README.md;h=379a6c09483ea14c99db46adb93dc726732a0ac4;hb=93e9b6cc4e2b47a5fb32f093c38b7963e9c270aa;hp=e566d3161cd5b591e0aedf69f4ca2264f8ccdaf5;hpb=257e9d03b028402089c9f98f3acb25ba668c09af;p=openssl.git diff --git a/README.md b/README.md index e566d3161c..379a6c0948 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ Welcome to the OpenSSL Project ============================== -[![openssl logo][]][www.openssl.org] +[![openssl logo]][www.openssl.org] -[![travis badge][]][travis jobs] -[![appveyor badge][]][appveyor jobs] +[![github actions ci badge]][github actions ci] +[![appveyor badge]][appveyor jobs] OpenSSL is a robust, commercial-grade, full-featured Open Source Toolkit for the Transport Layer Security (TLS) protocol formerly known as the @@ -15,7 +15,7 @@ be used stand-alone. OpenSSL is descended from the SSLeay library developed by Eric A. Young and Tim J. Hudson. -The official Home Page of the OpenSSL Project is [www.openssl.org][]. +The official Home Page of the OpenSSL Project is [www.openssl.org]. Table of Contents ================= @@ -35,7 +35,7 @@ Overview The OpenSSL toolkit includes: - **libssl** - an implementation of all TLS protocol versions up to TLSv1.3 ([RFC 8446][]). + an implementation of all TLS protocol versions up to TLSv1.3 ([RFC 8446]). - **libcrypto** a full-strength general purpose cryptographic library. It constitutes the @@ -63,8 +63,8 @@ Source code tarballs of the official releases can be downloaded from The OpenSSL project does not distribute the toolkit in binary form. However, for a large variety of operating systems precompiled versions -of the OpenSSL toolkit are available. In particular on Linux and other -Unix operating systems it is normally recommended to link against the +of the OpenSSL toolkit are available. In particular, on Linux and other +Unix operating systems, it is normally recommended to link against the precompiled shared libraries provided by the distributor or vendor. For Testing and Development @@ -75,8 +75,8 @@ the source tarballs, having a local copy of the git repository with the entire project history gives you much more insight into the code base. -The official OpenSSL Git Repository is located at [git.openssl.org][]. -There is a GitHub mirror of the repository at [github.com/openssl/openssl][], +The official OpenSSL Git Repository is located at [git.openssl.org]. +There is a GitHub mirror of the repository at [github.com/openssl/openssl], which is updated automatically from the former on every commit. A local copy of the Git Repository can be obtained by cloning it from @@ -94,7 +94,7 @@ GitHub and clone your public fork instead. git clone https://github.com/yourname/openssl.git -This is necessary, because all development of OpenSSL nowadays is done via +This is necessary because all development of OpenSSL nowadays is done via GitHub pull requests. For more details, see [Contributing](#contributing). Build and Install @@ -105,17 +105,16 @@ detailed instructions about building and installing OpenSSL. For some platforms, the installation instructions are amended by a platform specific document. - * [NOTES.ANDROID](NOTES.ANDROID) - * [NOTES.DJGPP](NOTES.DJGPP) - * [NOTES.PERL](NOTES.PERL) - * [NOTES.UNIX](NOTES.UNIX) - * [NOTES.VALGRIND](NOTES.VALGRIND) - * [NOTES.VMS](NOTES.VMS) - * [NOTES.WIN](NOTES.WIN) + * [Notes for UNIX-like platforms](NOTES-UNIX.md) + * [Notes for Android platforms](NOTES-ANDROID.md) + * [Notes for Windows platforms](NOTES-WINDOWS.md) + * [Notes for the DOS platform with DJGPP](NOTES-DJGPP.md) + * [Notes for the OpenVMS platform](NOTES-VMS.md) + * [Notes on Perl](NOTES-PERL.md) + * [Notes on Valgrind](NOTES-VALGRIND.md) -Specific notes on upgrading to OpenSSL 3.0 from previous versions, as well as -known issues are available on the OpenSSL -[wiki](https://wiki.openssl.org/index.php/OpenSSL_3.0). +Specific notes on upgrading to OpenSSL 3.0 from previous versions can be found +in the [migration_guide(7ossl)] manual page. Documentation ============= @@ -127,13 +126,14 @@ The manual pages for the master branch and all current stable releases are available online. - [OpenSSL master](https://www.openssl.org/docs/manmaster) +- [OpenSSL 3.0](https://www.openssl.org/docs/man3.0) - [OpenSSL 1.1.1](https://www.openssl.org/docs/man1.1.1) Wiki ---- -There is a Wiki at [wiki.openssl.org][] which is currently not very active. -It contains a lot of useful information, not all of which is up to date. +There is a Wiki at [wiki.openssl.org] which is currently not very active. +It contains a lot of useful information, not all of which is up-to-date. License ======= @@ -142,13 +142,13 @@ OpenSSL is licensed under the Apache License 2.0, which means that you are free to get and use it for commercial and non-commercial purposes as long as you fulfill its conditions. -See the [LICENSE](LICENSE) file for more details. +See the [LICENSE.txt](LICENSE.txt) file for more details. Support ======= There are various ways to get in touch. The correct channel depends on -your requirement. see the [SUPPORT](SUPPORT.md) file for more details. +your requirement. See the [SUPPORT](SUPPORT.md) file for more details. Contributing ============ @@ -156,22 +156,17 @@ Contributing If you are interested and willing to contribute to the OpenSSL project, please take a look at the [CONTRIBUTING](CONTRIBUTING.md) file. -Since 2016, development takes place in public on the GitHub open source -platform. The OpenSSL Project Pages at [openssl.github.io][] are a -valuable source of information if you want to get familiar with our -development process on GitHub. - Legalities ========== A number of nations restrict the use or export of cryptography. If you are -potentially subject to such restrictions you should seek legal advice before +potentially subject to such restrictions, you should seek legal advice before attempting to develop or distribute cryptographic code. Copyright ========= -Copyright (c) 1998-2020 The OpenSSL Project +Copyright (c) 1998-2022 The OpenSSL Project Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson @@ -195,40 +190,33 @@ All rights reserved. "OpenSSL GitHub Mirror" -[openssl.github.io]: - - "OpenSSL Project Pages" - [wiki.openssl.org]: "OpenSSL Wiki" +[migration_guide(7ossl)]: + + "OpenSSL Migration Guide" + [RFC 8446]: - [openssl logo]: doc/images/openssl.svg "OpenSSL Logo" -[travis badge]: - - "Travis Build Status" +[github actions ci badge]: + + "GitHub Actions CI Status" -[travis jobs]: - - "Travis Jobs" +[github actions ci]: + + "GitHub Actions CI" [appveyor badge]: - + "AppVeyor Build Status" [appveyor jobs]: