Add Docs for EVP_CIPHER-*

[openssl.git] / README.md

diff --git a/README.md b/README.md
index a0ea69074a1f619f5161805ae61b7b554c2862d0..680faea76f1cca9a948fd85ee927a4e1be3cd159 100644 (file)
--- 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
@@ -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
@@ -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).
+known issues are available on the [OpenSSL 3.0 Wiki] page.
 
 Documentation
 =============
@@ -132,7 +131,7 @@ available online.
 Wiki
 ----
 
-There is a Wiki at [wiki.openssl.org][] which is currently not very active.
+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
@@ -156,11 +155,6 @@ 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
 ==========
 
@@ -171,7 +165,7 @@ attempting to develop or distribute cryptographic code.
 Copyright
 =========
 
-Copyright (c) 1998-2020 The OpenSSL Project
+Copyright (c) 1998-2021 The OpenSSL Project
 
 Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
 
@@ -195,40 +189,33 @@ All rights reserved.
     <https://github.com/openssl/openssl>
     "OpenSSL GitHub Mirror"
 
-[openssl.github.io]:
-    <https://mspncp.github.io>
-    "OpenSSL Project Pages"
-
 [wiki.openssl.org]:
     <https://wiki.openssl.org>
     "OpenSSL Wiki"
 
+[OpenSSL 3.0 Wiki]:
+    <https://wiki.openssl.org/index.php/OpenSSL_3.0>
+    "OpenSSL 3.0 Wiki"
+
 [RFC 8446]:
      <https://tools.ietf.org/html/rfc8446>
 
 <!-- Logos and Badges -->
-<!--
-  Note: The security token for the appveyor badge (the random number in
-  the URL below) was obtained for the mspncp/openssl project.
-  It needs to be replaced by the correct token by some core member
-  (@levitte, @mattcaswell?). It can be obtained for project members at
-  https://ci.appveyor.com/project/openssl/openssl/settings/badges.
--->
 
 [openssl logo]:
     doc/images/openssl.svg
     "OpenSSL Logo"
 
-[travis badge]:
-    <https://travis-ci.org/openssl/openssl.svg?branch=master>
-    "Travis Build Status"
+[github actions ci badge]:
+    <https://github.com/openssl/openssl/workflows/GitHub%20CI/badge.svg>
+    "GitHub Actions CI Status"
 
-[travis jobs]:
-    <https://travis-ci.org/openssl/openssl>
-    "Travis Jobs"
+[github actions ci]:
+    <https://github.com/openssl/openssl/actions?query=workflow%3A%22GitHub+CI%22>
+    "GitHub Actions CI"
 
 [appveyor badge]:
-    <https://ci.appveyor.com/api/projects/status/ikn2l4u1xsume63u/branch/master?svg=true>
+    <https://ci.appveyor.com/api/projects/status/8e10o7xfrg73v98f/branch/master?svg=true>
     "AppVeyor Build Status"
 
 [appveyor jobs]: