diff options
author | Egor Tensin <Egor.Tensin@gmail.com> | 2015-07-12 02:35:21 +0300 |
---|---|---|
committer | Egor Tensin <Egor.Tensin@gmail.com> | 2015-07-12 02:35:21 +0300 |
commit | c3225c3db188cf30cb11f633b14cfc08c082f47b (patch) | |
tree | f8f7394ff192f35814c624a72f12f2ba8ac0ac92 /README.md | |
parent | README updates (diff) | |
download | aes-tools-c3225c3db188cf30cb11f633b14cfc08c082f47b.tar.gz aes-tools-c3225c3db188cf30cb11f633b14cfc08c082f47b.zip |
README updates
Diffstat (limited to '')
-rw-r--r-- | README.md | 26 |
1 files changed, 17 insertions, 9 deletions
@@ -1,24 +1,30 @@ # aesni -Simple AES encryption algorithm implementation using the AES-NI instruction set. +Simple AES encryption algorithm implementation using the AES-NI instruction +set. ## Building -I've used the compiler and the assembler shipped with Visual Studio Express 2013 with Update 4 for Windows Desktop. +I've used the compiler and the assembler shipped with Visual Studio Express +2013 with Update 4 for Windows Desktop. You can generate the solution using CMake and build it using Visual Studio. Some of the utilities also depend on a few Boost libraries. -In particular, Boost.ProgramOptions has to be built prior to building these utilities. -To enable CMake to find Boost libraries, pass the path to the root Boost directory like this: +In particular, Boost.ProgramOptions has to be built prior to building these +utilities. +To enable CMake to find Boost libraries, pass the path to the root Boost +directory like this: cmake -D BOOST_ROOT=C:\workspace\third-party\boost_1_58_0 ... -Remember that in order to link to the static Boost libraries, you also have to pass `-D Boost_USE_STATIC_LIBS=ON` to CMake. +Remember that in order to link to the static Boost libraries, you also have to +pass `-D Boost_USE_STATIC_LIBS=ON` to CMake. ## Running on older CPUs -To run the executables that are using the AES-NI instruction set on a CPU w/o the support for these instructions, one can use +To run the executables that are using the AES-NI instruction set on a CPU w/o +the support for these instructions, one can use [Intel Software Development Emulator](https://software.intel.com/en-us/articles/intel-software-development-emulator). You can then run an executable like this: @@ -27,7 +33,8 @@ You can then run an executable like this: ## Documentation -You can generate the docs using [Doxygen](http://www.stack.nl/~dimitri/doxygen/). +You can generate the docs using +[Doxygen](http://www.stack.nl/~dimitri/doxygen/). The docs will be put into the `doc` directory in the repository's root. ## Utilities @@ -40,5 +47,6 @@ See [Testing](test#testing). ## Licensing -This project, including all of the files and their contents, is licensed under the terms of the MIT License. -See LICENSE.txt for details. +This project, including all of the files and their contents, is licensed under +the terms of the MIT License. +See [LICENSE.txt](LICENSE.txt) for details. |