aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBrent Cook <bcook@openbsd.org>2015-08-03 07:19:25 -0500
committerBrent Cook <bcook@openbsd.org>2015-08-03 07:19:25 -0500
commit3465c5105b4bbec56a2a2f6ffd0dda1f4f5f71fa (patch)
tree79cac73b1ab54831342b60aa1cebb892e7a30bcf /README.md
parent75b90b157cbbbb6c9cba09b15718e241a3b7eee0 (diff)
downloadportable-3465c5105b4bbec56a2a2f6ffd0dda1f4f5f71fa.tar.gz
portable-3465c5105b4bbec56a2a2f6ffd0dda1f4f5f71fa.tar.bz2
portable-3465c5105b4bbec56a2a2f6ffd0dda1f4f5f71fa.zip
update build information
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
1 files changed, 38 insertions, 3 deletions
diff --git a/README.md b/README.md
index 501f7bb..6d452cf 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,8 @@
1![LibreSSL image](http://www.libressl.org/images/libressl.jpg) 1![LibreSSL image](http://www.libressl.org/images/libressl.jpg)
2## Official portable version of [LibreSSL](http://www.libressl.org) ## 2## Official portable version of [LibreSSL](http://www.libressl.org) ##
3 3
4[![Build Status](https://travis-ci.org/libressl-portable/portable.svg?branch=master)](https://travis-ci.org/libressl-portable/portable)
5
4LibreSSL is a fork of [OpenSSL](https://www.openssl.org) 1.0.1g developed by the 6LibreSSL is a fork of [OpenSSL](https://www.openssl.org) 1.0.1g developed by the
5[OpenBSD](http://www.openbsd.org) project. Our goal is to modernize the codebase, 7[OpenBSD](http://www.openbsd.org) project. Our goal is to modernize the codebase,
6improve security, and apply best practice development processes from OpenBSD. 8improve security, and apply best practice development processes from OpenBSD.
@@ -37,7 +39,7 @@ At the time of this writing, LibreSSL is know to build and work on:
37LibreSSL also supports the following Windows environments: 39LibreSSL also supports the following Windows environments:
38* Microsoft Windows (XP or higher, x86 and x64) 40* Microsoft Windows (XP or higher, x86 and x64)
39* Wine (32-bit and 64-bit) 41* Wine (32-bit and 64-bit)
40* Builds with Mingw-w64 and Cygwin 42* Builds with Mingw-w64, Cygwin, and Visual Studio
41 43
42Official release tarballs are available at your friendly neighborhood 44Official release tarballs are available at your friendly neighborhood
43OpenBSD mirror in directory 45OpenBSD mirror in directory
@@ -67,7 +69,7 @@ prepare the source tree for building:
67## Building LibreSSL ## 69## Building LibreSSL ##
68 70
69Once you have a source tree from Git or FTP, run these commands to build and 71Once you have a source tree from Git or FTP, run these commands to build and
70install the package on most systems. 72install the package on most systems:
71 73
72```sh 74```sh
73./configure # see ./configure --help for configuration options 75./configure # see ./configure --help for configuration options
@@ -75,6 +77,26 @@ make check # runs builtin unit tests
75make install # set DESTDIR= to install to an alternate location 77make install # set DESTDIR= to install to an alternate location
76``` 78```
77 79
80If you wish to use the CMake build system, use these commands:
81
82```sh
83mkdir build
84cd build
85cmake ..
86make
87make test
88```
89
90For faster builds, you can use Ninja as well:
91
92```sh
93mkdir build-ninja
94cd build-ninja
95cmake -G"Ninja" ..
96ninja
97ninja test
98```
99
78### OS specific build information: ### 100### OS specific build information: ###
79 101
80#### HP-UX (11i) #### 102#### HP-UX (11i) ####
@@ -95,4 +117,17 @@ LibreSSL builds against relatively recent versions of Mingw-w64, not to be
95confused with the original mingw.org project. Mingw-w64 3.2 or later 117confused with the original mingw.org project. Mingw-w64 3.2 or later
96should work. See README.windows for more information 118should work. See README.windows for more information
97 119
98[![Build Status](https://travis-ci.org/libressl-portable/portable.svg?branch=master)](https://travis-ci.org/libressl-portable/portable) 120#### Windows - Visual Studio ####
121
122LibreSSL builds using the CMake target "Visual Studio 12 2013", and may build
123against older/newer targets as well. To generate a Visual Studio project,
124install CMake, enter the LibreSSL source directory and run:
125
126```sh
127 mkdir build-vs2013
128 cd build-vs2013
129 cmake -G"Visual Studio 12 2013" ..
130```
131
132This will generate a LibreSSL.sln file that you can incorporate into other
133projects or build by itself.