From 7dcb02169a633aee353772016ffadd77c8247956 Mon Sep 17 00:00:00 2001 From: Doug Hogan Date: Sat, 13 Jun 2015 23:11:08 -0700 Subject: Rename to README.md and add markdown Since it's now a foreign project in automake, we can use github markdown in the README. --- README | 87 --------------------------------------------------------- README.md | 96 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 96 insertions(+), 87 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index dc0276c..0000000 --- a/README +++ /dev/null @@ -1,87 +0,0 @@ -This package is the official portable version of LibreSSL - (http://www.libressl.org). - -LibreSSL is a fork of OpenSSL 1.0.1 developed by the OpenBSD project. - (http://www.openbsd.org). - -Compatibility with OpenSSL: - - LibreSSL is API compatible with OpenSSL 1.0.1, but does not yet include all - new APIs from OpenSSL 1.0.2 and later. LibreSSL also includes APIs not yet - present in OpenSSL. The current common API subset is OpenSSL 1.0.1. - - LibreSSL it is not ABI compatible with any release of OpenSSL, or necessarily - earlier releases of LibreSSL. You will need to relink your programs to - LibreSSL in order to use it, just as in moving between major versions of OpenSSL. - LibreSSL's installed library version numbers are incremented to account for - ABI and API changes. - -Compatibility with other operating systems: - - While primarily developed on and taking advantage of APIs available on OpenBSD, - the LibreSSL portable project attempts to provide working alternatives for - other operating systems, and assists with improving OS-native implementations - where possible. - -At the time of this writing, LibreSSL is know to build and work on: - - - Linux (kernel 3.17 or later recommended) - - FreeBSD (tested with 9.2 and later) - - NetBSD (tested with 6.1.5) - - HP-UX (11i) - - Solaris (11 and later preferred) - - Mac OS X (tested with 10.8 and later) - - AIX (5.3 and later) - -LibreSSL also supports the following Windows environments: - - Microsoft Windows (Vista or higher, x86 and x64) - - Wine (32-bit and 64-bit) - - Builds with Mingw-w64 and Cygwin - -Official release tarballs are available at your friendly neighborhood -OpenBSD mirror in directory LibreSSL, e.g.: - - http://ftp.openbsd.org/pub/OpenBSD/LibreSSL/ - -although we suggest that you use a mirror: - - http://www.openbsd.org/ftp.html - -The LibreSSL portable build framework is also mirrored in Github: - - https://github.com/libressl-portable/portable - -Please report bugs either to tech@openbsd.org, or to the github issue tracker: - - https://github.com/libressl-portable/portable/issues - -If you have checked this source using Git, follow these initial steps to -prepare the source tree for building: - - 1. ensure you have the following packages installed: - automake, autoconf, bash, git, libtool, perl, pod2man - 2. run './autogen.sh' to prepare the source tree for building - or run './dist.sh' to prepare a tarball. - -Once you have a source tree from Git or FTP, run these commands to build and -install the package on most systems. - - ./configure # see ./configure --help for configuration options - make check # runs builtin unit tests - make install # set DESTDIR= to install to an alternate location - -OS specific build information: - - - HP-UX (11i) - Set the UNIX_STD environment variable to '2003' before running 'configure' - in order to build with the HP C/aC++ compiler. See the "standards(5)" man - page for more details. - - export UNIX_STD=2003 - ./configure - make - - - Windows - Mingw-w64 - LibreSSL builds against relatively recent versions of Mingw-w64, not to be - confused with the original mingw.org project. Mingw-w64 3.2 or later - should work. See README.windows for more information diff --git a/README.md b/README.md new file mode 100644 index 0000000..f1e5199 --- /dev/null +++ b/README.md @@ -0,0 +1,96 @@ +![LibreSSL image](http://www.libressl.org/images/libressl.jpg) +## Official portable version of [LibreSSL](http://www.libressl.org) ## + +LibreSSL is a fork of [OpenSSL](https://www.openssl.org) 1.0.1g developed by the +[OpenBSD](http://www.openbsd.org) project. Our goal is to modernize the codebase, +improve security, and apply best practice development processes from OpenBSD. + +## Compatibility with OpenSSL: ## + +LibreSSL is API compatible with OpenSSL 1.0.1, but does not yet include all +new APIs from OpenSSL 1.0.2 and later. LibreSSL also includes APIs not yet +present in OpenSSL. The current common API subset is OpenSSL 1.0.1. + +LibreSSL it is not ABI compatible with any release of OpenSSL, or necessarily +earlier releases of LibreSSL. You will need to relink your programs to +LibreSSL in order to use it, just as in moving between major versions of OpenSSL. +LibreSSL's installed library version numbers are incremented to account for +ABI and API changes. + +## Compatibility with other operating systems: ## + +While primarily developed on and taking advantage of APIs available on OpenBSD, +the LibreSSL portable project attempts to provide working alternatives for +other operating systems, and assists with improving OS-native implementations +where possible. + +At the time of this writing, LibreSSL is know to build and work on: + +* Linux (kernel 3.17 or later recommended) +* FreeBSD (tested with 9.2 and later) +* NetBSD (tested with 6.1.5) +* HP-UX (11i) +* Solaris (11 and later preferred) +* Mac OS X (tested with 10.8 and later) +* AIX (5.3 and later) + +LibreSSL also supports the following Windows environments: +* Microsoft Windows (Vista or higher, x86 and x64) +* Wine (32-bit and 64-bit) +* Builds with Mingw-w64 and Cygwin + +Official release tarballs are available at your friendly neighborhood +OpenBSD mirror in directory +[LibreSSL](http://ftp.openbsd.org/pub/OpenBSD/LibreSSL/), +although we suggest that you use a [mirror](http://www.openbsd.org/ftp.html). + +The LibreSSL portable build framework is also +[mirrored](https://github.com/libressl-portable/portable) in Github. + +Please report bugs either to the public libressl@openbsd.org mailing list, +or to the github +[issue tracker](https://github.com/libressl-portable/portable/issues) + +Severe vulnerabilities or bugs requiring coordination with OpenSSL can be +sent to the core team at libressl-security@openbsd.org. + +## Prerequisites when building from git ## + +If you have checked this source using Git, follow these initial steps to +prepare the source tree for building: + +1. Ensure you have the following packages installed: + automake, autoconf, bash, git, libtool, perl, pod2man +2. Run './autogen.sh' to prepare the source tree for building or + run './dist.sh' to prepare a tarball. + +## Building LibreSSL ## + +Once you have a source tree from Git or FTP, run these commands to build and +install the package on most systems. + +```sh +./configure # see ./configure --help for configuration options +make check # runs builtin unit tests +make install # set DESTDIR= to install to an alternate location +``` + +### OS specific build information: ### + +#### HP-UX (11i) #### + +Set the UNIX_STD environment variable to '2003' before running 'configure' +in order to build with the HP C/aC++ compiler. See the "standards(5)" man +page for more details. + +```sh +export UNIX_STD=2003 +./configure +make +``` + +#### Windows - Mingw-w64 #### + +LibreSSL builds against relatively recent versions of Mingw-w64, not to be +confused with the original mingw.org project. Mingw-w64 3.2 or later +should work. See README.windows for more information -- cgit v1.2.3-55-g6feb