summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorDr. Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>2019-11-28 23:56:36 +0100
committerDr. Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>2020-02-26 21:04:38 +0100
commit2e07506a12e126894cd820304465162bc0e732b4 (patch)
tree648f913d16c376e043a59c1336ca783bdd9779ba /README
parent1ec45faba59660f3c0ce8ea0c19fb3a63b12b069 (diff)
downloadopenssl-new-2e07506a12e126894cd820304465162bc0e732b4.tar.gz
doc: convert standard project docs to markdown
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)
Diffstat (limited to 'README')
-rw-r--r--README92
1 files changed, 0 insertions, 92 deletions
diff --git a/README b/README
deleted file mode 100644
index 5bd9e13f17..0000000000
--- a/README
+++ /dev/null
@@ -1,92 +0,0 @@
-
- Copyright (c) 1998-2018 The OpenSSL Project
- Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
- All rights reserved.
-
- DESCRIPTION
- -----------
-
- The OpenSSL Project is a collaborative effort to develop a robust,
- commercial-grade, fully featured, and Open Source toolkit implementing the
- Transport Layer Security (TLS) protocols (including SSLv3) as well as a
- full-strength general purpose cryptographic library.
-
- OpenSSL is descended from the SSLeay library developed by Eric A. Young
- and Tim J. Hudson.
-
- The OpenSSL toolkit 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.
-
- OVERVIEW
- --------
-
- The OpenSSL toolkit includes:
-
- libssl (with platform specific naming):
- Provides the client and server-side implementations for SSLv3 and TLS.
-
- libcrypto (with platform specific naming):
- Provides general cryptographic and X.509 support needed by SSL/TLS but
- not logically part of it.
-
- openssl:
- A command line tool that can be used for:
- Creation of key parameters
- Creation of X.509 certificates, CSRs and CRLs
- Calculation of message digests
- Encryption and decryption
- SSL/TLS client and server tests
- Handling of S/MIME signed or encrypted mail
- And more...
-
- INSTALLATION
- ------------
-
- See the appropriate file:
- INSTALL Linux, Unix, Windows, OpenVMS, ...
- NOTES.* INSTALL addendums for different platforms
-
- SUPPORT
- -------
-
- See the OpenSSL website www.openssl.org for details on how to obtain
- commercial technical support. Free community support is available through the
- openssl-users email list (see
- https://www.openssl.org/community/mailinglists.html for further details).
-
- If you have any problems with OpenSSL then please take the following steps
- first:
-
- - Download the latest version from the repository
- to see if the problem has already been addressed
- - Configure with no-asm
- - Remove compiler optimization flags
-
- If you wish to report a bug then please include the following information
- and create an issue on GitHub:
-
- - OpenSSL version: output of 'openssl version -a'
- - Configuration data: output of 'perl configdata.pm --dump'
- - OS Name, Version, Hardware platform
- - Compiler Details (name, version)
- - Application Details (name, version)
- - Problem Description (steps that will reproduce the problem, if known)
- - Stack Traceback (if the application dumps core)
-
- Just because something doesn't work the way you expect does not mean it
- is necessarily a bug in OpenSSL. Use the openssl-users email list for this type
- of query.
-
- HOW TO CONTRIBUTE TO OpenSSL
- ----------------------------
-
- See CONTRIBUTING
-
- LEGALITIES
- ----------
-
- A number of nations restrict the use or export of cryptography. If you
- are potentially subject to such restrictions you should seek competent
- professional legal advice before attempting to develop or distribute
- cryptographic code.