Commit 26dee42d authored by Matt Caswell's avatar Matt Caswell
Browse files

Bring the README file up to date 



The README file was a little out of date so needed a refresh

Reviewed-by: default avatarRich Salz <rsalz@openssl.org>
Reviewed-by: default avatarRichard Levitte <levitte@openssl.org>
parent 7d6df9e9

README

+16 −18
Original line number Diff line number Diff line
@@ -10,11 +10,8 @@ 


 The OpenSSL Project is a collaborative effort to develop a robust,

 commercial-grade, fully featured, and Open Source toolkit implementing the

 Secure Sockets Layer (SSLv3) and Transport Layer Security (TLS) protocols as

 well as a full-strength general purpose cryptographic library. The project is

 managed by a worldwide community of volunteers that use the Internet to

 communicate, plan, and develop the OpenSSL toolkit and its related

 documentation.

 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 a dual-license (the
@@ -55,7 +52,9 @@ 
 -------



 See the OpenSSL website www.openssl.org for details on how to obtain

 commercial technical support.

 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:
@@ -68,12 +67,11 @@ 
 If you wish to report a bug then please include the following information in

 any bug report:



    - On Unix systems:

        Self-test report generated by 'make report'

    - On other systems:

        OpenSSL version: output of 'openssl version -a'

        OS Name, Version, Hardware platform

        Compiler Details (name, version)

    - OpenSSL version: output of 'openssl version -a'

    - Any "Configure" options that you selected during compilation of the

      library if applicable (see INSTALL)

    - 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)
@@ -83,8 +81,8 @@ 
    rt@openssl.org



 In order to avoid spam, this is a moderated mailing list, and it might

 take a day for the ticket to show up.  (We also scan posts to make sure

 that security disclosures aren't publically posted by mistake.) Mail

 take a couple of days for the ticket to show up.  (We also scan posts to make

 sure that security disclosures aren't publically posted by mistake.) Mail

 to this address is recorded in the public RT (request tracker) database

 (see https://www.openssl.org/community/index.html#bugs for details) and

 also forwarded the public openssl-dev mailing list.  Confidential mail
@@ -93,11 +91,11 @@ 


 Please do NOT use this for general assistance or support queries.

 Just because something doesn't work the way you expect does not mean it

 is necessarily a bug in OpenSSL.

 is necessarily a bug in OpenSSL. Use the openssl-users email list for this type

 of query.



 You can also make GitHub pull requests. If you do this, please also send

 mail to rt@openssl.org with a link to the PR so that we can more easily

 keep track of it.

 You can also make GitHub pull requests. See the CONTRIBUTING file for more

 details.



 HOW TO CONTRIBUTE TO OpenSSL

 ----------------------------