Permalink
Browse files

Added documentation

Signed-off-by: Samuli Seppänen <samuli@openvpn.net>
  • Loading branch information...
mattock committed Feb 21, 2013
1 parent c791010 commit 520c2b53509413ac3a5ceecabb3cbc93c74625f7
Showing with 107 additions and 1 deletion.
  1. +30 −0 README
  2. +6 −1 generic/README
  3. +21 −0 msvc/README
  4. +50 −0 windows-nsis/README
View
30 README
@@ -0,0 +1,30 @@
+OpenVPN project buildsystems
+
+About
+
+ These directories contain scripts to help build and
+ package OpenVPN and it's dependencies for various
+ hardware platforms and operating systems (e.g. Windows,
+ ARM). You do not need any of these scripts if you're
+ building a native version of OpenVPN on a UNIX-like
+ operatingsystem.
+
+ Thorough documentation is available in the OpenVPN wiki:
+
+ <https://community.openvpn.net/openvpn>
+
+Directories
+
+ The "generic" subdir contains scripts to cross-compile
+ OpenVPN using mingw_w64 (e.g. Linux -> Windows).
+
+ The "msvc" subdir is used to compile OpenVPN on Windows
+ for Windows using Microsoft Visual Studio tools. Please
+ note that the "msvc" buildsystem is not actively
+ maintained anymore.
+
+ The "windows-nsis" subdir contains scripts to
+ cross-compile and package OpenVPN for Windows.
+
+ Please refer to the README files in the subdirectories
+ for further information.
View
@@ -1,10 +1,15 @@
-OpenVPN Project Cross Compile Build
+OpenVPN project cross-compile buildsystem
About
This environment provides an easy way to build
OpenVPN Project components using a cross compiler.
+ More thorough documentation is available in the OpenVPN
+ wiki:
+
+ <https://community.openvpn.net/openvpn>
+
Versions
The tarballs are taken from "SOURCEROOT" directory, the
View
@@ -0,0 +1,21 @@
+OpenVPN project Microsoft Visual C buildsystem
+
+About
+
+ This subdirectory contains scripts for building OpenVPN
+ and all it's dependencies using Microsoft Visual C.
+
+ Note that this buildsystem is not actively maintained
+ anymore, and people are strongly encouraged to use the
+ cross-compile (mingw_w64) buildsystem instead. For
+ details look here:
+
+ ../generic/README
+ ../windows-nsis/README
+
+Usage
+
+ If you're sure you _need_ to build using MSVC, please
+ refer to instructions in the OpenVPN wiki:
+
+ <https://community.openvpn.net/openvpn>
View
@@ -0,0 +1,50 @@
+OpenVPN project cross-compile buildsystem
+Windows NSIS packaging wrapper
+
+About
+
+ This subdirectory contains scripts for building OpenVPN
+ and all it's dependencies and packaging the results into
+ Windows NSIS 32- and 64-bit installers. The scripts in
+ ../generic are used for building the components.
+
+ More thorough documentation is available in the OpenVPN
+ wiki:
+
+ <https://community.openvpn.net/openvpn>
+
+Usage
+
+ First you need to configure the build environment. You
+ can make persistent changes by editing two
+ configuration files:
+
+ ../generic/build.vars (build configuration)
+ build-complete.vars (packaging configuration)
+
+ You can also change the build configuration temporarily
+ using shell variables (see below).
+
+ To create an unsigned release build use
+
+ ./build-complete
+
+ Overriding build configuration using shell variables:
+
+ TAP_WINDOWS_INSTALLER_URL=http://domain.com/tap.exe\
+ ./build-complete
+
+ To create a signed snapshot from Git sources, use
+ "build-snapshot":
+
+ ./build-snapshot --sign
+ --sign-pkcs12=signingkey.p12\
+ --sign-pkcs12-pass=yourpassphrase\
+ --sign-timestamp="http://timestamp.domain.com"
+
+ To make a release build use "build-complete" instead:
+
+ ./build-complete --sign
+ --sign-pkcs12=signingkey.p12\
+ --sign-pkcs12-pass=yourpassphrase\
+ --sign-timestamp="http://timestamp.domain.com"

0 comments on commit 520c2b5

Please sign in to comment.