aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2017-05-23 05:11:40 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2017-05-23 05:11:40 +0300
commitc2b2b524dfbc1770ef69b4a69fc03bea57573888 (patch)
treec9971f778f7369e527a151b706c04af00d06413e
parentcommon.cmake update (diff)
downloadaes-tools-c2b2b524dfbc1770ef69b4a69fc03bea57573888.tar.gz
aes-tools-c2b2b524dfbc1770ef69b4a69fc03bea57573888.zip
README update
-rw-r--r--README.md48
1 files changed, 23 insertions, 25 deletions
diff --git a/README.md b/README.md
index 7318f29..01950e1 100644
--- a/README.md
+++ b/README.md
@@ -3,37 +3,35 @@ AES tools
Simple AES implementation and utilities.
-Prerequisites
--------------
-
-To build the solution, you first need to build a few of Boost's libraries.
-The complete list of Boost dependencies is:
-
-* Boost.Filesystem,
-* Boost.Program_options,
-* Boost.System.
-
Building
--------
Create the build files using CMake and build using your native build tools
(Visual Studio/make/etc.).
-For example, using Visual Studio 2013 Update 4 for Windows Desktop (targetting
-x86 and using static Boost libraries):
-
- > cd
- C:\workspace\personal\build\aes-tools
-
- > cmake -G "Visual Studio 12 2013" ^
- -D BOOST_ROOT=C:\workspace\third-party\boost_1_58_0 ^
- -D Boost_USE_STATIC_LIBS=ON ^
- -D Boost_USE_STATIC_RUNTIME=ON ^
- C:\workspace\personal\aes-tools
- ...
-
- > msbuild aes_tools.sln
- ...
+* **Prerequisites.**
+The following Boost libraries are required to build the project: Filesystem,
+Program_options, System.
+* **Customization.**
+The runtime libraries are linked statically by default (when this project is
+the root CMake project).
+Therefore, the Boost dependencies must also link them statically.
+You can link the runtime dynamically by passing `-D USE_STATIC_RUNTIME=OFF` to
+`cmake`.
+* **Example.**
+In the example below, the project directory is
+"C:\workspace\personal\aes-tools", Boost can be found in
+"C:\workspace\third-party\boost_1_58_0" and Visual Studio 2013 is used,
+targeting x86.
+
+ > cmake -G "Visual Studio 12 2013" ^
+ -D BOOST_ROOT=C:\workspace\third-party\boost_1_58_0 ^
+ -D Boost_USE_STATIC_RUNTIME=ON ^
+ C:\workspace\personal\aes-tools
+ ...
+
+ > cmake --build . --config release -- /m
+ ...
Usage on older CPUs
-------------------