Reshape the README file out of the existing README stuff
[openssl.git] / README
diff --git a/README b/README
index 2170309..71ab133 100644 (file)
--- a/README
+++ b/README
@@ -5,6 +5,9 @@
  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
  Secure Sockets Layer (SSL v2/v3) and Transport Layer Security (TLS v1)
@@ -18,6 +21,9 @@
  that you are free to get and use it for commercial and non-commercial
  purposes as long as you fullfill the conditions of both licenses. 
 
+ OVERVIEW
+ --------
+
  The OpenSSL toolkit includes:
 
  libssl.a:
      errstr  - Convert from OpenSSL hex error codes to a readable form.
      nseq    - Netscape certificate sequence utility
         
+ PATENTS
+ -------
+
+ Various companies hold various patents for various algorithms in various
+ locations around the world. YOU are responsible for ensuring that your use of
+ any algorithms is legel by checking if there are any patents in your country.
+ The file contains some of the patents that we know about or are rumoured to
+ exist. This is not a definitive list.
+
+ RSA Data Security holds software patents on the RSA and RC5 algorithms.  If
+ their ciphers are used used inside the USA (and Japan?), you must contact RSA
+ Data Security for licencing conditions. Their web page is
+ http://www.rsa.com/.
+
+ RC4 is a trademark of RSA Data Security, so use of this label should perhaps
+ only be used with RSA Data Security's permission. 
+
+ The IDEA algorithm is patented by Ascom in Austria, France, Germany, Italy,
+ Japan, Netherlands, Spain, Sweden, Switzerland, UK and the USA.  They should
+ be contacted if that algorithm is to be used, their web page is
+ http://www.ascom.ch/.
+
+ INSTALLATION
+ ------------
+
  To install this package under a Unix derivative, read the INSTALL file.  For
  a Win32 platform, read the INSTALL.W32 file.
 
  lists the functions, you will probably have to look at the code to work out
  how to used them. Look at the example programs.
 
+ SUPPORT 
+ -------
+
+ If you have any problems with OpenSSL then please take the following steps
+ first:
+
+    - Remove ASM versions of libraries
+    - Remove compiler optimisation flags 
+    - Add compiler debug flags (if using gcc then remove -fomit-frame-pointer
+      before you try to debug things)
+
+ If you wish to report a bug then please include the following information in
+ any bug report:
+
+    OpenSSL Details
+    - Version, most of these details can be got from the
+      'openssl version -a' command.
+    Operating System Details
+    - OS Name
+    - OS Version
+    - Hardware platform
+    Compiler Details
+    - Name
+    - Version
+    Application Details 
+    - Name 
+    - Version 
+    Problem Description
+    - include steps that will reproduce the problem (if known)
+    Stack Traceback (if the application dumps core)
+
+ Report the bug to the OpenSSL project at:
+
+    openssl-users@openssl.org
+