diff options
| author | Mounir IDRASSI <mounir.idrassi@idrix.fr> | 2017-07-10 00:13:07 +0200 |
|---|---|---|
| committer | Mounir IDRASSI <mounir.idrassi@idrix.fr> | 2017-07-10 00:14:19 +0200 |
| commit | bc9e7222111260843aec9cb1501d0f988b5831d0 (patch) | |
| tree | a23d9495388535ef7354c99dac64c17844350187 /src | |
| parent | 342b8636d839b93cc1fad1ecf48650116c1edf99 (diff) | |
| download | VeraCrypt-bc9e7222111260843aec9cb1501d0f988b5831d0.tar.gz VeraCrypt-bc9e7222111260843aec9cb1501d0f988b5831d0.zip | |
Update Readme to mention FreeBSD support and remove reference to OpenSolaris
Diffstat (limited to 'src')
| -rw-r--r-- | src/Readme.txt | 78 |
1 files changed, 40 insertions, 38 deletions
diff --git a/src/Readme.txt b/src/Readme.txt index 05d48cd3..65f5d1e7 100644 --- a/src/Readme.txt +++ b/src/Readme.txt @@ -18,16 +18,16 @@ Contents ======== I. Windows -Requirements for Building VeraCrypt for Windows -Instructions for Building VeraCrypt for Windows -Instructions for Signing and Packaging VeraCrypt for Windows + Requirements for Building VeraCrypt for Windows. + Instructions for Building VeraCrypt for Windows. + Instructions for Signing and Packaging VeraCrypt for Windows. II. Linux and Mac OS X -Requirements for Building VeraCrypt for Linux and Mac OS X -Instructions for Building VeraCrypt for Linux and Mac OS X -Mac OS X specifics + Requirements for Building VeraCrypt for Linux and Mac OS X. + Instructions for Building VeraCrypt for Linux and Mac OS X. + Mac OS X specifics -III. FreeBSD and OpenSolaris +III. FreeBSD IV. Third-Party Developers (Contributors) @@ -78,16 +78,16 @@ Instructions for Building VeraCrypt for Windows: ------------------------------------------------ 1) Create an environment variable 'MSVC16_ROOT' pointing to the folder 'MSVC15' -extracted from the Visual C++ 1.52 self-extracting package. + extracted from the Visual C++ 1.52 self-extracting package. -Note: The 16-bit installer MSVC15\SETUP.EXE cannot be run on 64-bit Windows, -but it is actually not necessary to run it. You only need to extract the -folder 'MSVC15', which contains the 32-bit binaries required to build the -VeraCrypt Boot Loader. + Note: The 16-bit installer MSVC15\SETUP.EXE cannot be run on 64-bit Windows, + but it is actually not necessary to run it. You only need to extract the + folder 'MSVC15', which contains the 32-bit binaries required to build the + VeraCrypt Boot Loader. 2) If you have installed the Windows Driver Development Kit in another -directory than '%SYSTEMDRIVE%\WinDDK', create an environment variable -'WINDDK_ROOT' pointing to the DDK installation directory. + directory than '%SYSTEMDRIVE%\WinDDK', create an environment variable + 'WINDDK_ROOT' pointing to the DDK installation directory. 3) Open the solution file 'VeraCrypt.sln' in Microsoft Visual Studio 2010. @@ -96,7 +96,7 @@ directory than '%SYSTEMDRIVE%\WinDDK', create an environment variable 5) Build the solution. 6) If successful, there should be newly built VeraCrypt binaries in the -'Release' folder. + 'Release' folder. Instructions for Signing and Packaging VeraCrypt for Windows: ------------------------------------------------------------- @@ -115,7 +115,7 @@ VeraCrypt EFI Boot Loader: -------------------------- VeraCrypt source code contains pre-built EFI binaries under src\Boot\EFI. -The source code of VeraCrypt EFI Boot Loader is licensed under LGPL and +The source code of VeraCrypt EFI Boot Loader is licensed under LGPL and it is available at https://github.com/veracrypt/VeraCrypt-DCS. For build instructions, please refer to the file src\Boot\EFI\Readme.txt. @@ -132,9 +132,9 @@ Requirements for Building VeraCrypt for Linux and Mac OS X: - YASM 1.3.0 or newer (Linux only, x86/x64 architecture only) - pkg-config - wxWidgets 3.0 shared library and header files installed or -wxWidgets 3.0 library source code (available at https://www.wxwidgets.org) + wxWidgets 3.0 library source code (available at https://www.wxwidgets.org) - FUSE library and header files (available at https://github.com/libfuse/libfuse -and https://osxfuse.github.io/) + and https://osxfuse.github.io/) Instructions for Building VeraCrypt for Linux and Mac OS X: @@ -143,33 +143,33 @@ Instructions for Building VeraCrypt for Linux and Mac OS X: 1) Change the current directory to the root of the VeraCrypt source code. 2) If you have no wxWidgets shared library installed, run the following -command to configure the wxWidgets static library for VeraCrypt and to -build it: + command to configure the wxWidgets static library for VeraCrypt and to + build it: -$ make WXSTATIC=1 WX_ROOT=/usr/src/wxWidgets wxbuild + $ make WXSTATIC=1 WX_ROOT=/usr/src/wxWidgets wxbuild -The variable WX_ROOT must point to the location of the source code of the -wxWidgets library. Output files will be placed in the './wxrelease/' -directory. + The variable WX_ROOT must point to the location of the source code of the + wxWidgets library. Output files will be placed in the './wxrelease/' + directory. 3) To build VeraCrypt, run the following command: -$ make + $ make -or if you have no wxWidgets shared library installed: + or if you have no wxWidgets shared library installed: -$ make WXSTATIC=1 + $ make WXSTATIC=1 4) If successful, the VeraCrypt executable should be located in the directory -'Main'. + 'Main'. By default, a universal executable supporting both graphical and text user interface (through the switch --text) is built. On Linux, a console-only executable, which requires no GUI library, can be built using the 'NOGUI' parameter: -$ make NOGUI=1 WXSTATIC=1 WX_ROOT=/usr/src/wxWidgets wxbuild -$ make NOGUI=1 WXSTATIC=1 + $ make NOGUI=1 WXSTATIC=1 WX_ROOT=/usr/src/wxWidgets wxbuild + $ make NOGUI=1 WXSTATIC=1 On MacOSX, building a console-only executable is not supported. @@ -179,16 +179,16 @@ Mac OS X specifics: Under MacOSX, the SDK for OSX 10.7 is used by default. To use another version of the SDK (i.e. 10.6), you can export the environment variable VC_OSX_TARGET: -$ export VC_OSX_TARGET=10.6 + $ export VC_OSX_TARGET=10.6 Before building under MacOSX, pkg-config must be installed if not yet available. Get it from https://pkgconfig.freedesktop.org/releases/pkg-config-0.28.tar.gz and compile using the following commands : -$ ./configure --with-internal-glib -$ make -$ sudo make install + $ ./configure --with-internal-glib + $ make + $ sudo make install After making sure pkg-config is available, download and install OSXFuse from https://osxfuse.github.io/ (MacFUSE compatibility layer must selected) @@ -200,7 +200,7 @@ VeraCrypt sources (i.e. if "src" path is "/Users/joe/Projects/VeraCrypt/src" then wxWidgets should be at "/Users/joe/Projects/wxWidgets-3.0.3") The build process uses Code Signing certificates whose ID is specified in -src/Main/Main.make (look for lines containing "Developer ID Application" and +src/Main/Main.make (look for lines containing "Developer ID Application" and "Developer ID Installer"). You'll have to modify these lines to put the ID of your Code Signing certificates or comment them if you don't have one. @@ -210,10 +210,12 @@ Thus, we recommend using a different OSX SDK version for building VeraCrypt. -III. FreeBSD and OpenSolaris +III. FreeBSD ============================ -FreeBSD and OpenSolaris are not yet supported. +FreeBSD is supported starting from version 11. +The build requirements and instructions are the same as Linux except that gmake +should be used instead of make. @@ -223,7 +225,7 @@ IV. Third-Party Developers (Contributors) If you intend to implement a feature, please contact us first to make sure: 1) That the feature has not been implemented (we may have already implemented -it, but haven't released the code yet). + it, but haven't released the code yet). 2) That the feature is acceptable. 3) Whether we need help of third-party developers with implementing the feature. |