diff options
author | Doug Hogan <github@acyclic.org> | 2015-06-13 23:11:08 -0700 |
---|---|---|
committer | Doug Hogan <github@acyclic.org> | 2015-06-13 23:11:08 -0700 |
commit | 7dcb02169a633aee353772016ffadd77c8247956 (patch) | |
tree | e6ff8379954ce7674c8ce541d7b59e2d20fd5ea7 /README | |
parent | 407c7cd1f52c7ba9b885980a18904ff98c31a9d9 (diff) | |
download | portable-7dcb02169a633aee353772016ffadd77c8247956.tar.gz portable-7dcb02169a633aee353772016ffadd77c8247956.tar.bz2 portable-7dcb02169a633aee353772016ffadd77c8247956.zip |
Rename to README.md and add markdown
Since it's now a foreign project in automake, we can use github markdown
in the README.
Diffstat (limited to 'README')
-rw-r--r-- | README | 87 |
1 files changed, 0 insertions, 87 deletions
@@ -1,87 +0,0 @@ | |||
1 | This package is the official portable version of LibreSSL | ||
2 | (http://www.libressl.org). | ||
3 | |||
4 | LibreSSL is a fork of OpenSSL 1.0.1 developed by the OpenBSD project. | ||
5 | (http://www.openbsd.org). | ||
6 | |||
7 | Compatibility with OpenSSL: | ||
8 | |||
9 | LibreSSL is API compatible with OpenSSL 1.0.1, but does not yet include all | ||
10 | new APIs from OpenSSL 1.0.2 and later. LibreSSL also includes APIs not yet | ||
11 | present in OpenSSL. The current common API subset is OpenSSL 1.0.1. | ||
12 | |||
13 | LibreSSL it is not ABI compatible with any release of OpenSSL, or necessarily | ||
14 | earlier releases of LibreSSL. You will need to relink your programs to | ||
15 | LibreSSL in order to use it, just as in moving between major versions of OpenSSL. | ||
16 | LibreSSL's installed library version numbers are incremented to account for | ||
17 | ABI and API changes. | ||
18 | |||
19 | Compatibility with other operating systems: | ||
20 | |||
21 | While primarily developed on and taking advantage of APIs available on OpenBSD, | ||
22 | the LibreSSL portable project attempts to provide working alternatives for | ||
23 | other operating systems, and assists with improving OS-native implementations | ||
24 | where possible. | ||
25 | |||
26 | At the time of this writing, LibreSSL is know to build and work on: | ||
27 | |||
28 | - Linux (kernel 3.17 or later recommended) | ||
29 | - FreeBSD (tested with 9.2 and later) | ||
30 | - NetBSD (tested with 6.1.5) | ||
31 | - HP-UX (11i) | ||
32 | - Solaris (11 and later preferred) | ||
33 | - Mac OS X (tested with 10.8 and later) | ||
34 | - AIX (5.3 and later) | ||
35 | |||
36 | LibreSSL also supports the following Windows environments: | ||
37 | - Microsoft Windows (Vista or higher, x86 and x64) | ||
38 | - Wine (32-bit and 64-bit) | ||
39 | - Builds with Mingw-w64 and Cygwin | ||
40 | |||
41 | Official release tarballs are available at your friendly neighborhood | ||
42 | OpenBSD mirror in directory LibreSSL, e.g.: | ||
43 | |||
44 | http://ftp.openbsd.org/pub/OpenBSD/LibreSSL/ | ||
45 | |||
46 | although we suggest that you use a mirror: | ||
47 | |||
48 | http://www.openbsd.org/ftp.html | ||
49 | |||
50 | The LibreSSL portable build framework is also mirrored in Github: | ||
51 | |||
52 | https://github.com/libressl-portable/portable | ||
53 | |||
54 | Please report bugs either to tech@openbsd.org, or to the github issue tracker: | ||
55 | |||
56 | https://github.com/libressl-portable/portable/issues | ||
57 | |||
58 | If you have checked this source using Git, follow these initial steps to | ||
59 | prepare the source tree for building: | ||
60 | |||
61 | 1. ensure you have the following packages installed: | ||
62 | automake, autoconf, bash, git, libtool, perl, pod2man | ||
63 | 2. run './autogen.sh' to prepare the source tree for building | ||
64 | or run './dist.sh' to prepare a tarball. | ||
65 | |||
66 | Once you have a source tree from Git or FTP, run these commands to build and | ||
67 | install the package on most systems. | ||
68 | |||
69 | ./configure # see ./configure --help for configuration options | ||
70 | make check # runs builtin unit tests | ||
71 | make install # set DESTDIR= to install to an alternate location | ||
72 | |||
73 | OS specific build information: | ||
74 | |||
75 | - HP-UX (11i) | ||
76 | Set the UNIX_STD environment variable to '2003' before running 'configure' | ||
77 | in order to build with the HP C/aC++ compiler. See the "standards(5)" man | ||
78 | page for more details. | ||
79 | |||
80 | export UNIX_STD=2003 | ||
81 | ./configure | ||
82 | make | ||
83 | |||
84 | - Windows - Mingw-w64 | ||
85 | LibreSSL builds against relatively recent versions of Mingw-w64, not to be | ||
86 | confused with the original mingw.org project. Mingw-w64 3.2 or later | ||
87 | should work. See README.windows for more information | ||