From 376f911b4c5ca7bcdfc25142660d8ce23d2dfd8e Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Tue, 21 Jun 2016 19:53:05 +0300 Subject: README updates --- README.md | 38 +++++++++++++++++++++++--------------- 1 file changed, 23 insertions(+), 15 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index c0f85a5..f303794 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,22 @@ -# AES tools +AES tools +========= Simple AES implementation and utilities. -## Development +Development +----------- ### Prerequisites -* Boost.Filesystem, Boost.Program_options and Boost.System +To build the whole solution, you first need to build a few of Boost's +libraries. +The complete list of Boost dependencies is: -### Building the utilities +* 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.). @@ -25,10 +33,11 @@ x86 and using static Boost libraries): C:\workspace\personal\aes-tools ... - > msbuild aes-tools.sln + > msbuild aes_tools.sln ... -## Usage on older CPUs +Usage on older CPUs +------------------- To run the executables that are using the AES-NI instruction set on a CPU without the support for these instructions, you can use [Intel Software @@ -40,26 +49,25 @@ After you install the emulator, you can run an executable like this: [Intel Software Development Emulator]: https://software.intel.com/en-us/articles/intel-software-development-emulator -## Documentation +Documentation +------------- You can generate the docs using [Doxygen]. The docs will be generated in the "doc/" directory under the project's root. [Doxygen]: http://www.stack.nl/~dimitri/doxygen/ -## Utilities +See also +-------- -See [Utilities]. +* [Utilities] +* [Testing] [Utilities]: utils/README.md - -## Testing - -See [Testing]. - [Testing]: test/README.md -## License +License +------- This project, including all of the files and their contents, is licensed under the terms of the MIT License. -- cgit v1.2.3