diff --git a/README.md b/README.md index e6af90d1..2380eacc 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,12 @@ VI. Further Information I. Windows ========== -A detailed guide on how to compile VeraCrypt on Windows can be found at: https://www.veracrypt.fr/en/CompilingGuidelineWin.html +Requirements for Building VeraCrypt for Windows: +------------------------------------------------ + +A detailed guide on how to build VeraCrypt on Windows can be found in +the file doc/html/CompilingGuidelineWin.html. it is also available online +at https://www.veracrypt.fr/en/CompilingGuidelineWin.html IMPORTANT: @@ -87,7 +92,9 @@ For build instructions, please refer to the file src\Boot\EFI\Readme.txt. II. Linux and Mac OS X ====================== -A detailed guide on how to build a dev environment and on how to compile VeraCrypt on Linux can be found at: https://www.veracrypt.fr/en/CompilingGuidelineLinux.html +A detailed guide on how to build VeraCrypt on Linux can be found in +the file doc/html/CompilingGuidelineLinux.html. it is also available online +at https://www.veracrypt.fr/en/CompilingGuidelineLinux.html Requirements for Building VeraCrypt for Linux and Mac OS X: ----------------------------------------------------------- diff --git a/doc/chm/VeraCrypt.hhc b/doc/chm/VeraCrypt.hhc index d5b5b095..0394ff89 100644 --- a/doc/chm/VeraCrypt.hhc +++ b/doc/chm/VeraCrypt.hhc @@ -390,6 +390,20 @@ +
  • + + + +
  • diff --git a/doc/chm/VeraCrypt.hhp b/doc/chm/VeraCrypt.hhp index 3f66edd0..775bba57 100644 --- a/doc/chm/VeraCrypt.hhp +++ b/doc/chm/VeraCrypt.hhp @@ -50,6 +50,9 @@ Cascades.html Changing Passwords and Keyfiles.html Choosing Passwords and Keyfiles.html Command Line Usage.html +CompilingGuidelineLinux.html +CompilingGuidelines.html +CompilingGuidelineWin.html Contact.html Contributed Resources.html Converting TrueCrypt volumes and partitions.html diff --git a/doc/chm/create_chm.bat b/doc/chm/create_chm.bat index 4d9be6d8..ffc53ebe 100644 --- a/doc/chm/create_chm.bat +++ b/doc/chm/create_chm.bat @@ -3,8 +3,9 @@ PATH=%PATH%;C:\Program Files (x86)\HTML Help Workshop set CHMBUILDPATH=%~dp0 cd %CHMBUILDPATH% -copy ..\html\* . +xcopy /E ..\html\* . hhc VeraCrypt.hhp del /F /Q *.html *.css *.jpg *.gif *.png *.svg +rmdir /s /Q CompilingGuidelineWin ru diff --git a/doc/html/CompilingGuidelineLinux.html b/doc/html/CompilingGuidelineLinux.html index a8460518..bf256b6e 100644 --- a/doc/html/CompilingGuidelineLinux.html +++ b/doc/html/CompilingGuidelineLinux.html @@ -16,38 +16,11 @@ } .texttohide { - display:none; font-family: Helvetica,sans-serif; font-size: 14px; font-weight: normal; } -.show { - display: none; - text-decoration: none; -} - -.hide:target + .show { - display: inline; - text-decoration: none; -} - -.hide:target { - display: none; - text-decoration: none; -} - -.hide:target ~ .texttohide { - display:inline; - text-decoration: none; - -} - -@media print { - .hide, .show { - display: none; - } -} @@ -80,12 +53,16 @@

    Documentation >> -Compiling Gudineline for Linux +Technical Details +>> +Building VeraCrypt From Source +>> +Linux Build Guide

    -This guide describes how to set up a Linux System that can compile the VeraCrypt. Further it is described how VeraCrypt is going to be compiled.
    -The procedure for a Ubuntu 22.04 LTS system is described here as an example, but the procedure for other Linux systems is analogous. +This guide describes how to set up a Linux System to build VeraCrypt from source and how to perform compilation.
    +The procedure for a Ubuntu 22.04 LTS system is described here as an example, the procedure for other Linux systems is analogous.
    @@ -94,7 +71,7 @@ The procedure for a Ubuntu 22.04 LTS system is described here as an example, but The following components are required for compiling VeraCrypt:
    1. GNU Make
    2. -
    3. GNU C++ Compiler 4.0
    4. +
    5. GNU C/C++ Compiler
    6. YASM 1.3.0
    7. pkg-config
    8. wxWidgets 3.2 shared library and header files installed or wxWidgets 3.0 library source code
    9. @@ -103,8 +80,18 @@ The following components are required for compiling VeraCrypt:
    -If you do not want to perform the single steps below, you can run these commands to build an environment and to compile VeraCrpyt:
    -Download as script: Script
    +

    Below are the detailed procedure steps:

    + +

    They can also be performed by running the below list of commands in a terminal or by copying them to a script:

    sudo apt update
    sudo apt install -y build-essential yasm pkg-config libgtk-3-dev
    @@ -125,12 +112,12 @@ git clone https://github.com/veracrypt/VeraCrypt.git cd ~/VeraCrypt/src
    make
    +

    - Installation of GNU Make - Installation of GNU Make + Installation of GNU Make

      @@ -150,8 +137,7 @@ make
    - Installation of GNU C++ Compiler 4.0 - Installation of GNU C++ Compiler 4.0 + Installation of GNU C/C++ Compiler

    If the build-essential were already installed in the step before, this step can be skipped.

      @@ -171,8 +157,7 @@ make
    - Installation of YASM - Installation of YASM + Installation of YASM

      @@ -192,8 +177,7 @@ make
    - Installation of pkg-config - Installation of pkg-config + Installation of pkg-config

      @@ -213,8 +197,7 @@ make
    - Installation of wxWidgets 3.2 - Installation of wxWidgets 3.2 + Installation of wxWidgets 3.2

      @@ -244,8 +227,7 @@ make
    - Installation of libfuse - Installation of libfuse + Installation of libfuse

      @@ -265,8 +247,7 @@ make
    - Download VeraCrypt - Download VeraCrypt + Download VeraCrypt

      @@ -287,8 +268,7 @@ make
    - Compile VeraCrypt - Compile VeraCrypt + Compile VeraCrypt

    Remarks:

      diff --git a/doc/html/CompilingGuidelineWin.html b/doc/html/CompilingGuidelineWin.html index 5b5554c2..a7508166 100644 --- a/doc/html/CompilingGuidelineWin.html +++ b/doc/html/CompilingGuidelineWin.html @@ -16,38 +16,11 @@ } .texttohide { - display:none; font-family: Helvetica,sans-serif; font-size: 14px; font-weight: normal; } -.show { - display: none; - text-decoration: none; -} - -.hide:target + .show { - display: inline; - text-decoration: none; -} - -.hide:target { - display: none; - text-decoration: none; -} - -.hide:target ~ .texttohide { - display:inline; - text-decoration: none; - -} - -@media print { - .hide, .show { - display: none; - } -} @@ -80,7 +53,11 @@

      Documentation >> -Compiling Gudineline for Windows +Technical Details +>> +Building VeraCrypt From Source +>> +Windows Build Guide

    @@ -113,11 +90,36 @@ The following components are required for compiling VeraCrypt:
    +
    - Installation of Microsoft Visual Studio 2010 - Installation of Microsoft Visual Studio 2010 + Installation of Microsoft Visual Studio 2010

      @@ -145,8 +147,7 @@ The following components are required for compiling VeraCrypt:
    - Installation of Microsoft Visual Studio 2010 Service Pack 1 - Installation of Microsoft Visual Studio 2010 Service Pack 1 + Installation of Microsoft Visual Studio 2010 Service Pack 1

    Note: The content the official installer from Microsoft tries to download is no longer available. Therefore, it is necessary to use an offline installer. @@ -170,8 +171,7 @@ The following components are required for compiling VeraCrypt:

    - Installation of NASM - Installation of NASM + Installation of NASM

      @@ -227,8 +227,7 @@ The following components are required for compiling VeraCrypt:
    - Installation of YASM - Installation of YASM + Installation of YASM

      @@ -311,8 +310,7 @@ The following components are required for compiling VeraCrypt:
    - Installation of Microsoft Visual C++ 1.52 - Installation of Microsoft Visual C++ 1.52 + Installation of Microsoft Visual C++ 1.52

      @@ -363,8 +361,7 @@ The following components are required for compiling VeraCrypt:
    - Installation of the Windows SDK 7.1 - Installation of the Windows SDK 7.1 + Installation of the Windows SDK 7.1

    The installer requires .Net Framework 4 (Not a newer one like .Net Framework 4.8!). Since a newer version is already preinstalled with Windows 10, the installer has to be tricked: @@ -446,8 +443,7 @@ The following components are required for compiling VeraCrypt:

    - Installation of the Windows Driver Kit 7.1 - Installation of the Windows Driver Kit 7.1 + Installation of the Windows Driver Kit 7.1

      @@ -471,8 +467,7 @@ The following components are required for compiling VeraCrypt:
    - Installation of the Windows 8.1 SDK - Installation of the Windows 8.1 SDK + Installation of the Windows 8.1 SDK

      @@ -520,8 +515,7 @@ The following components are required for compiling VeraCrypt:
    - Installation of gzip - Installation of gzip + Installation of gzip

      @@ -578,8 +572,7 @@ The following components are required for compiling VeraCrypt:
    - Installation of upx - Installation of upx + Installation of upx

      @@ -636,8 +629,7 @@ The following components are required for compiling VeraCrypt:
    - Installation of 7zip - Installation of 7zip + Installation of 7zip

      @@ -654,8 +646,7 @@ The following components are required for compiling VeraCrypt:
    - Installation of Wix3 - Installation of Wix3 + Installation of Wix3

      @@ -672,8 +663,7 @@ The following components are required for compiling VeraCrypt:
    - Installation of Microsoft Visual Studio 2019 - Installation of Microsoft Visual Studio 2019 + Installation of Microsoft Visual Studio 2019

      @@ -908,8 +898,7 @@ The following components are required for compiling VeraCrypt:
    - Installation of the Windows Driver Kit 2004 - Installation of the Windows Driver Kit 2004 + Installation of the Windows Driver Kit 2004

      @@ -934,8 +923,7 @@ The following components are required for compiling VeraCrypt:
    - Installation of the Visual Studio build tools - Installation of the Visual Studio build tools + Installation of the Visual Studio build tools

      @@ -1025,8 +1013,7 @@ The following components are required for compiling VeraCrypt:
    - Download VeraCrypt Source Files - Download VeraCrypt Source Files + Download VeraCrypt Source Files

      @@ -1044,8 +1031,7 @@ The following components are required for compiling VeraCrypt:
    - Compile the Win32/x64 Versions of VeraCrypt - Compile the Win32/x64 Versions of VeraCrypt + Compile the Win32/x64 Versions of VeraCrypt

      @@ -1081,8 +1067,7 @@ The following components are required for compiling VeraCrypt:
    - Compile the ARM64 Version of VeraCrypt - Compile the ARM64 Version of VeraCrypt + Compile the ARM64 Version of VeraCrypt

      @@ -1107,8 +1092,7 @@ The following components are required for compiling VeraCrypt:
    - Build the VeraCrypt Executables - Build the VeraCrypt Executables + Build the VeraCrypt Executables

      @@ -1130,8 +1114,7 @@ The following components are required for compiling VeraCrypt:
    - Import the Certificates - Import the Certificates + Import the Certificates

    With the sign_test.bat script you just signed the VeraCrypt executables. This is necessary, since Windows only accepts drivers, which are trusted by a signed Certificate Authority.
    Since you did not use the official VeraCrypt signing certificate to sign your code, but a public development version, you have to import and therefore trust the certifcates used. @@ -1156,8 +1139,7 @@ The following components are required for compiling VeraCrypt:

    - Known Issues - Known Issues + Known Issues

    diff --git a/src/Readme.txt b/src/Readme.txt index 6875547d..2380eacc 100644 --- a/src/Readme.txt +++ b/src/Readme.txt @@ -41,7 +41,9 @@ I. Windows Requirements for Building VeraCrypt for Windows: ------------------------------------------------ -A detailed guide on how to compile VeraCrypt on Windows can be found at: https://www.veracrypt.fr/en/CompilingGuidelineWin.html +A detailed guide on how to build VeraCrypt on Windows can be found in +the file doc/html/CompilingGuidelineWin.html. it is also available online +at https://www.veracrypt.fr/en/CompilingGuidelineWin.html IMPORTANT: @@ -90,7 +92,9 @@ For build instructions, please refer to the file src\Boot\EFI\Readme.txt. II. Linux and Mac OS X ====================== -A detailed guide on how to build a dev environment and on how to compile VeraCrypt on Linux can be found at: https://www.veracrypt.fr/en/CompilingGuidelineLinux.html +A detailed guide on how to build VeraCrypt on Linux can be found in +the file doc/html/CompilingGuidelineLinux.html. it is also available online +at https://www.veracrypt.fr/en/CompilingGuidelineLinux.html Requirements for Building VeraCrypt for Linux and Mac OS X: -----------------------------------------------------------