aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md41
1 files changed, 24 insertions, 17 deletions
diff --git a/README.md b/README.md
index 1365397..7177ea0 100644
--- a/README.md
+++ b/README.md
@@ -4,14 +4,14 @@ Simple AES implementation and utilities.
## Building
-I've used the compiler and the assembler shipped with Visual Studio Express
-2013 with Update 4 for Windows Desktop.
+To build the project:
-You can generate the solution using CMake and build it using Visual Studio.
+1. generate the solution aes_tools.sln using CMake,
+2. build the solution using Visual Studio.
-Some of the utilities also depend on a few Boost libraries.
-In particular, Boost.Filesystem, Boost.Program\_options, and Boost.System has
-to be built prior to building these utilities.
+Some of the [utilities] also depend on a few Boost libraries.
+In particular, Boost.Filesystem, Boost.Program\_options, and Boost.System must
+be built prior to building these utilities.
To enable CMake to find Boost libraries, pass the path to the root Boost
directory like this:
@@ -20,32 +20,39 @@ directory like this:
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
+## Usage 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
-[Intel Software Development Emulator](https://software.intel.com/en-us/articles/intel-software-development-emulator).
-You can then run an executable like this:
+the support for these instructions, you can use [Intel Software Development
+Emulator].
+After you install the emulator, you can run an executable like this:
> sde -- encrypt_block.exe -a aes128 -m ecb -- 000102030405060708090a0b0c0d0e0f 00112233445566778899aabbccddeeff
69c4e0d86a7b0430d8cdb78070b4c55a
## Documentation
-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.
+You can generate the docs using [Doxygen].
+The docs will be put to the `doc/` directory under the project's root.
## Utilities
-See [Utilities](utils#utilities).
+See [Utilities].
## Testing
-See [Testing](test#testing).
+See [Testing].
-## Licensing
+## License
This project, including all of the files and their contents, is licensed under
the terms of the MIT License.
-See LICENSE.txt for details.
+See [LICENSE.txt] for details.
+
+
+
+[LICENSE.txt]: LICENSE.txt
+[Doxygen]: http://www.stack.nl/~dimitri/doxygen/
+[Intel Software Development Emulator]: https://software.intel.com/en-us/articles/intel-software-development-emulator
+[testing]: test/README.md
+[utilities]: utils/README.md