5f8e6c50bd
The goal is to transform the standard documents
README, INSTALL, SUPPORT, CONTRIBUTING, ...
from a pure text format into markdown format, but in such a way
that the documentation remains nicely formatted an easy readable
when viewed with an normal text editor.
To achieve this goal, we use a special form of 'minimalistic' markdown
which interferes as little as possible with the reading flow.
* avoid [ATX headings][] and use [setext headings][] instead
(works for `<h1>` and `<h2>` headings only).
* avoid [inline links][] and use [reference links][] instead.
* avoid [fenced code blocks][], use [indented-code-blocks][] instead.
The transformation will take place in several steps. This commit
introduces mostly changes the formatting and does not chang the
content significantly.
[ATX headings]: https://github.github.com/gfm/#atx-headings
[setext headings]: https://github.github.com/gfm/#setext-headings
[inline links]: https://github.github.com/gfm/#inline-link
[reference links]: https://github.github.com/gfm/#reference-link
[fenced code blocks]: https://github.github.com/gfm/#fenced-code-blocks
[indented code blocks]: https://github.github.com/gfm/#indented-code-blocks
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/10545)
|
||
|---|---|---|
| .github | ||
| Configurations | ||
| VMS | ||
| apps | ||
| boringssl@2070f8ad91 | ||
| crypto | ||
| demos | ||
| doc | ||
| engines | ||
| external/perl | ||
| fuzz | ||
| include | ||
| krb5@890ca2f401 | ||
| ms | ||
| os-dep | ||
| providers | ||
| pyca-cryptography@09403100de | ||
| ssl | ||
| test | ||
| tools | ||
| util | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| .travis-apt-pin.preferences | ||
| .travis-create-release.sh | ||
| .travis.yml | ||
| ACKNOWLEDGEMENTS.md | ||
| AUTHORS.md | ||
| CHANGES.md | ||
| CONTRIBUTING.md | ||
| Configure | ||
| FAQ.md | ||
| HACKING | ||
| INSTALL.md | ||
| LICENSE | ||
| NEWS.md | ||
| NOTES.ANDROID | ||
| NOTES.DJGPP | ||
| NOTES.PERL | ||
| NOTES.UNIX | ||
| NOTES.VALGRIND | ||
| NOTES.VMS | ||
| NOTES.WIN | ||
| README.ENGINE | ||
| README.FIPS | ||
| README.md | ||
| SUPPORT.md | ||
| VERSION | ||
| appveyor.yml | ||
| build.info | ||
| config | ||
| config.com | ||
| configdata.pm.in | ||
| e_os.h | ||
README.md
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 Provides the client and server-side implementations for SSLv3 and TLS.
-
libcrypto: 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: General installation instructions for all platforms
- Additional instructions for specific 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.
Copyright
Copyright (c) 1998-2018 The OpenSSL Project
Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
All rights reserved.