summaryrefslogtreecommitdiff
path: root/Install.txt
diff options
context:
space:
mode:
authorJeffrey Walton <noloader@gmail.com>2021-02-02 19:39:45 -0500
committerJeffrey Walton <noloader@gmail.com>2021-02-02 19:39:45 -0500
commit9b2884e66b48cea31d9da801a3dd3ac51502444d (patch)
tree499f355bdf696b37ef51de9aa91e6a7936225944 /Install.txt
parent6d460d9265db113370c963db41bb0312d1fb5e3c (diff)
downloadcryptopp-git-9b2884e66b48cea31d9da801a3dd3ac51502444d.tar.gz
Update Install.txt (GH #1006)
Diffstat (limited to 'Install.txt')
-rw-r--r--Install.txt11
1 files changed, 6 insertions, 5 deletions
diff --git a/Install.txt b/Install.txt
index 0a567bbf..6b47f649 100644
--- a/Install.txt
+++ b/Install.txt
@@ -22,21 +22,20 @@ You should look through the GNUmakefile and config.h to ensure settings look rea
Wiki pages are available for some platforms with specific build instructions. The pages include Android, ARM, iOS, MSBuild and Solaris. Solaris users should visit the wiki for important information on compiling the library with different versions of SunCC and options, and information on improving library performance and features.
-Crypto++ does not depend upon other tools or libraries. It does not use Autotools, does not use CMake, and does not use Boost. If you use an alternate build system, like Autotools or CMake, then see the warning below about CXXFLAGS and lack of -DNDEBUG. CMake is available in Master as a matter of convenience, but its not officially supported.
-
-There is a partially complete CmakeList.txt available on the wiki at http://www.cryptopp.com/wiki/CMake. It is not recommended for use because it is not in a good state. If you have CMake expertise and can work some problems, then please see the wiki page for tasks related to CMake.
+Crypto++ does not depend upon other tools or libraries. The library only needs GNU Make 3.80 on Unix & liux; or Visual Studio 2010 and above build tools on Windows. The library does not use Autotools, does not use CMake, and does not use Boost.
+Autotools and CMake projects are not officially supported. The build systems take too much time and effort. Unofficial projects are available at https://github.com/noloader/cryptopp-autotools and https://github.com/noloader/cryptopp-cmake. The projects provide a central location to support Autotools and CMake. Collaborators for Autotools and CMake are welcomed.
BUILDING THE LIBRARY
--------------------
-In general, all you should have to do is open a terminal, and then:
+In general, all you should have to do is open a terminal, cd to the crpytopp directory, and then:
make
make test
sudo make install
-The command above builds the static library and cryptest.exe program. It also uses a sane set of default flags, which are usually "-DNDEBUG -g2 -O3 -fPIC".
+The command above builds the static library and cryptest.exe program. It also uses a sane default flags, which are usually "-DNDEBUG -g2 -O3 -fPIC".
If you want to build the shared object, then issue:
@@ -82,6 +81,8 @@ Crypto++ does not enagage Specter remediations at this time. You can build with
CXXFLAGS="-DNDEBUG -g2 -O3 -mfunction-return=thunk -mindirect-branch=thunk" make
+The library does not support out-of-tree builds. You must cd to the Crypto++ directory before building. `make distclean` will return the Crypto++ directory to a pristine state.
+
BUILDING WITH VCPKG
-------------------