Return to readme.txt CVS log

Up to [truecrypt] / truecrypt

Annotation of truecrypt/readme.txt, revision 1.1.1.9

1.1       root        1: 
1.1.1.9 ! root        2: TrueCrypt 4.1 Source Code Distribution
1.1.1.8   root        3: Released by TrueCrypt Foundation
1.1       root        4: 
                      5: 
1.1.1.8   root        6: This archive contains the complete source code of TrueCrypt for all supported
                      7: operating systems and all supported hardware platforms.
1.1       root        8: 
                      9: 
1.1.1.8   root       10: Important
                     11: =========
1.1       root       12: 
1.1.1.8   root       13: You may use the source code contained in this archive only if you agree to the
                     14: license contained in the file 'License.txt', which is included in this archive.
                     15: Note that the license specifies conditions under which you may modify TrueCrypt
                     16: (for example, that a derived work must not be called "TrueCrypt").
1.1       root       17: 
                     18: 
                     19: 
1.1.1.8   root       20: Contents
                     21: ========
1.1       root       22: 
1.1.1.8   root       23: I. Windows
                     24:        Requirements for Building TrueCrypt for Windows
                     25:        Instructions for Building TrueCrypt for Windows
                     26: 
                     27: II. Linux
                     28:        Requirements for Building TrueCrypt for Linux
                     29:        Instructions for Building TrueCrypt for Linux
                     30:        Installing TrueCrypt
                     31:        Requirements for Running Truecrypt on Linux
                     32: 
                     33: III. Third-Party Developers
                     34: 
                     35: IV. Documentation
                     36: 
                     37: V. Further Information
                     38: 
                     39: 
                     40: 
                     41: I. Windows
                     42: ==========
                     43: 
                     44: Requirements for Building TrueCrypt for Windows:
                     45: ------------------------------------------------
                     46: 
                     47: - Microsoft Visual Studio .NET 2003 (version 7.1) or compatible
                     48: - Windows 2003 SP1 Driver Development Kit (build 3790.1830) or compatible
                     49: 
                     50: 
                     51: Instructions for Building TrueCrypt for Windows:
                     52: ------------------------------------------------
                     53: 
                     54: 1) Open 'Driver\Makefile' and change the 'DDK' variable to point to your
                     55:    Windows DDK directory
                     56: 2) Open the 'TrueCrypt.sln' solution in Microsoft Visual Studio
                     57: 3) Make sure 'All' is the active solution configuration
                     58: 4) Build the solution
                     59: 5) If successful, you should have a new TrueCrypt build in the 'Release' folder.
                     60: 
                     61: 
                     62: 
                     63: II. Linux
                     64: =========
                     65: 
                     66: Requirements for Building TrueCrypt for Linux:
                     67: ----------------------------------------------
                     68: 
                     69: - Standard development tools: make, gcc, ld, strip
                     70: 
1.1.1.9 ! root       71: - Source code of the Linux kernel, version 2.6.5 or higher/compatible.
1.1.1.8   root       72:   The version of the kernel source code and its configuration must match the
                     73:   one under which you will be running TrueCrypt. Linux kernel sources are
                     74:   available at: http://kernel.org/pub/linux/kernel/
                     75: 
                     76: - Linux kernel source code must be configured and all modules built
1.1.1.9 ! root       77:   (make config modules).  
1.1.1.8   root       78: 
                     79: 
                     80: Instructions for Building TrueCrypt for Linux:
                     81: ----------------------------------------------
                     82: 
                     83: To build TrueCrypt execute the following commands:
                     84: 
                     85: cd Linux
                     86: ./build.sh
                     87: 
                     88: The build script will first verify requirements for building TrueCrypt.
                     89: You may be prompted for additional information, which cannot be determined
                     90: automatically. Then the building process will start.
                     91: 
                     92: 
                     93: Installing TrueCrypt:
                     94: ---------------------
                     95: 
                     96: To build and install TrueCrypt, execute the following commands:
                     97: 
                     98: cd Linux
                     99: ./install.sh
                    100: 
                    101: The installation script will first verify requirements for running TrueCrypt.
                    102: If successful, you will be prompted for installation options. Afterwards, the
                    103: following files will be installed:
                    104: 
                    105: Kernel/truecrypt.ko
                    106: Cli/truecrypt
                    107: Cli/Man/truecrypt.1
                    108: 
                    109: 
                    110: Requirements for Running Truecrypt on Linux
                    111: -------------------------------------------
                    112: 
1.1.1.9 ! root      113: - Linux kernel version 2.6.5 or any higher/compatible version.
1.1.1.8   root      114:   
                    115: - Device mapper (dmsetup, http://sources.redhat.com/dm) and loop device
                    116:   (losetup) infrastructure, which are available in all major Linux
                    117:   distributions.
                    118: 
                    119: 
                    120: 
                    121: III. Third-Party Developers
                    122: ===========================
                    123: 
                    124: If you intend to implement a feature, please contact us first to make sure:
                    125: 
                    126: 1) That the feature has not been implemented (we may have already implemented
                    127:    it, but haven't released the code yet).
                    128: 2) That the feature is acceptable.
                    129: 3) Whether we need help of third-party developers with implementing the feature.
                    130:  
                    131: Information on how to contact us can be found at: 
                    132: http://www.truecrypt.org/contact.php
                    133: 
                    134: 
                    135: 
                    136: IV. Documentation
                    137: ==================
                    138: 
                    139: http://www.truecrypt.org/documentation.php
                    140: 
                    141: 
                    142: 
                    143: V. Further Information
                    144: =======================
                    145: 
                    146: http://www.truecrypt.org
1.1       root      147: 

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.