VeraCrypt
aboutsummaryrefslogtreecommitdiff
path: root/README.md
AgeCommit message (Collapse)AuthorFilesLines
2024-06-18Improve documentation (#1360)Deniz Türkoglu1-103/+78
* Improve markdown documentation in README.md This commit fixes some of the minor spelling mistakes and uses markdown formatting to link to local files, for documentation. * Remove reference to outdated packages installation This is a legacy installation file that is no longer maintained.
2024-06-16MacOSX: Update macOS specifics part of the ReadmeMounir IDRASSI1-8/+10
2024-06-16Improve and simplify macOS builds (#1276)Deniz Türkoglu1-3/+18
* Add missing macOS requirement for 'make package' We need packages for the last build step on macOS, update docs to reflect the requirement. * Add build instructions using homebrew On macOS, we can use a package manager to easily install dependencies. This simplifies onboarding and building Veracrypt. * Add flag to use homebrew packages When building, we can use prebuilt wxwidgets from homebrew to simplify and speed up local building. We also put the package behind a flag as it's optional during development. * Skip signing for local builds When building with homebrew, skip signing. This can be put behind a flag to enable, if needed. * Use system yasm on macOS if available The binary in the repo is not universal (x86_64) and therefore building fails on arm architecture if Rosetta is not installed. Use local yasm if available. * Build local arch only in development When building via homebrew and locally, build only the local arch which skips ASM for arm(Mx) for MacOS. This removes the need to have rosetta installed for building. * Fix compilation issue when COMPILE_ASM is undefined Use a conditional check for COMPILE_ASM not being false instead of true. This avoids passing the variable to other parts of the build script. * Set SDK 12 as the minimum requirement and target Align the requirement to SDK 12 in both the makefile and script, and update the comment to remove confusion. I chose to leave this on 12 to be on the side of err and support as many building platforms as possible, when we can support. The local script now also sets the target using the local sdk version. This should improve the local development experience. * Fix wrong architecture for macOS in x86 builds We now build only the current arch for local development builds in macOS. This change also fixes the x86 builds failing. * Add instructions brew backed macOS local builds Flags to build a local build using homebrew packages are not default and require parameter -b to build. We also don't build packages directly, which requires -p. * Fix wxwidgets not linking in local x86 macOS development builds * Clarify build location in the document
2024-04-10update zlib + copyright (#1302)DLL1251-2/+2
2023-10-05Update various copyright datesMounir IDRASSI1-2/+2
2023-08-20Update zlib to latest (#1181)DLL1251-1/+1
* Update zlib to latest * Update copyright Updated copyright of zlib.
2023-06-29Linux: Add libpcsclite dependency into compilation guide (#1136)Jertzukka1-0/+1
After the EMV support commits, the project won't build anymore without the new dependency of libpcsclite.
2023-05-25Update README.md (#1070)DLL1251-2/+2
* Update README.md Update Copyright. * Update README.md Updated The zlib copyright. * Revert "Update README.md" This reverts commit be0742d8d1db0f1f25a7e5207fbb47e2a2ce8157.
2023-05-25Update Libzip to latest 1.9.2 (#1071)DLL1251-1/+1
* Libzip 1.9.2 Updated Libzip to latest version 1.9.2 and changed version number in the config.h from 1.7.3 to 1.9.2. Not sure if anything else needs to be tweaked :) * Modified Libzip to work with Visual studio * Update README.md Update libzip copyright. * Added the missing files. I've added the missing files zipconf.h and config.h, I've missed those sorry for that!
2023-05-19Added line breaks between new copyright holders (#963)Marius Kjærstad1-2/+2
2023-05-19Add Hyperlinks to Content Table (#989)Ömer Faruk Özdemir1-10/+6
2022-12-11Documentation: remove usage of CSS collapsible to avoid breaking CHM ↵Mounir IDRASSI1-2/+9
generation. Add new entries to CHM. Remove example script file since its content is described inline in the documentation We need to generate CHM from the same HTML files as the documentation and so we are limited by CHM compatibility
2022-08-16Documentation overwork (#953)Felix Reichmann1-50/+3
Github PR: https://github.com/veracrypt/VeraCrypt/pull/953 * Create CompilingGuidelinerh * Initial Upload Windows Compiling Guide * Removed RIPEMD-160 from Product64.wxs. See commit from 21.03.2022 * Completed Win compiling guideline * Added link to detailed compiling guide * Added link to detailed compiling guide * Restructured docu main page * Added sourceforge link * Added compiling guide for Linux * References to detailed instructions * Revert "Removed RIPEMD-160 from Product64.wxs. See commit from 21.03.2022" This reverts commit 024ae2a4659a6d9e65673531338e10bd10b8a3a0. * Correction of a div box
2022-02-13Add missing copyright to README.mdMounir IDRASSI1-0/+1
2022-01-02Update copyright year to 2022Mounir IDRASSI1-2/+2
2021-09-05Update build requirements and instructions in ReadmeMounir IDRASSI1-22/+35
2021-09-04Minor cleanup of the repo (#822)a13460541-3/+3
* *: source files should not be executable * *: make sure files have final newline * *: remove BOM from text files * translations: unify headers * *: fix typos * *: trim excess whitespace
2021-08-30Update copyright year to 2021Mounir IDRASSI1-2/+2
2020-06-11Fix indentation in README.md (#596)Ben Mares1-5/+5
The commands in the instructions for Linux and Mac OS X were not displaying in typewriter font.
2020-03-10Update copyright year in creditsVeraCrypt_1.24-Update5Mounir IDRASSI1-3/+3
2019-11-02Start following IEEE 1541 agreed naming of bytes (#532)Meteor0id1-1/+1
* Start following IEEE 1541 agreed naming of bytes This standard exists to prevent any confusion about the actual number of bytes. It has been agreed on by experts and is being used more widespead these day. Let's start properly naming the number of bytes, which is absolutely important in disk encryption software. * Update LanguageStrings.cpp * Update UserInterface.cpp * kibibyte instead of kilobyte * kibibyte instead of kilobyte * MiB instead of MB * undo accidental deletions Odd indeed that two random lines were deleted in a previous commit. Probably happened when using a keyboard shortcut while editing the file. This fixes the issue. * Mb to Mib
2019-02-12Add copyright and license information of JitterEntropy library by Stephan ↵Mounir IDRASSI1-4/+5
Mueller
2018-08-12Added line breaks between copyright holders (#318)Marius Kjærstad1-10/+10
2018-03-18Update various copyright dates.Mounir IDRASSI1-4/+4
2017-07-10Update Readme to mention FreeBSD support and remove reference to OpenSolarisMounir IDRASSI1-3/+5
2017-06-29Minor TOC correctionRobert Svensson1-5/+5
Added missing punctuation to make TOC easier to read
2017-06-29Readme: Add YASM as a requirement for building VeraCrypt. Remove NASM and ↵Mounir IDRASSI1-2/+2
makeself requirement for Linux/MacOSX build. Make Readme.txt identical to README.md.
2017-06-29Readme: update statement concerning Mac OSX SDK to use for building VeraCrypt.Mounir IDRASSI1-1/+1
2017-06-23Update IDRIX copyright yearMounir IDRASSI1-2/+2
2017-06-05Linux/MacOSX: Use newer version 3.0.3 of wxWidgets. Update version in Readme.Mounir IDRASSI1-2/+2
2017-05-15Replace Codeplex links by ones on veracrypt.frMounir IDRASSI1-1/+1
2017-04-26Update zlib copyright noticeMounir IDRASSI1-1/+1
2016-12-07Readme: correct instructions about code signing under Mac OSXMounir IDRASSI1-11/+13
2016-10-18README: Added line breaks between copyright holderssandakersmann1-9/+9
Added line breaks between copyright holders in README.md
2016-10-18README: Fixed one link that was not workingsandakersmann1-1/+1
https://upx.sourceforge.net/ changed to https://upx.github.io/ since redirect do not have support for SSL.
2016-10-17README: Changed http:// to https:// on some linkssandakersmann1-4/+4
Changed http:// to https:// on some links in README.md
2016-10-17Update copyrights in legal notices and license file.Mounir IDRASSI1-2/+2
2016-10-17Readme: remove PKCS#11 headers as requirement since they are included in ↵Mounir IDRASSI1-14/+4
VeraCrypt source tree.
2016-08-17Add reference to VeraCrypt-DCS EFI Boot loader in Readme. Update copyrights.Mounir IDRASSI1-1/+14
2016-06-17Windows: Use Visual C++ 2010 instead of Visual C++ 2008.Mounir IDRASSI1-3/+3
2016-05-18Fix wxWidget expected directory for OSX installTim Strazzere1-1/+1
2016-05-10Remove trailing whitespaceDavid Foerster1-25/+25
2016-05-10Normalize all line terminatorsDavid Foerster1-264/+264
2016-01-20Update README URLs based on HTTP redirectsReadmeCritic1-1/+1
2016-01-03Windows: sign binaries using both SHA-1 and SHA-256 for maximum ↵Mounir IDRASSI1-262/+264
compatibility. Add requirement for Windows SDK 8.1 that contains signtool.exe version that enables this.
2015-12-25README: Add reference to UPX as a dependency on Windows in README.md.Mounir IDRASSI1-0/+1
2015-12-22Readme: fix markdown syntax, typos, and formatMatthias Kolja Miehl1-22/+23
2015-02-25Readme.md: indicate that on MacOSX building a console-only binary is not ↵Mounir IDRASSI1-2/+4
supported.
2015-01-02Readme: add makeself to the build requirements for Linux.Mounir IDRASSI1-1/+2
2014-11-08Add copy of src/Reader.txt to make Github happyMounir IDRASSI1-0/+257