aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2021-03-31 19:38:02 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2021-03-31 19:38:02 +0300
commitfc57a1fa4e0c74bcab836601cbd8677717b5064f (patch)
treedfdc93de86393affb6d54b674fa5247802f3f61c /README.md
parenttest: remove really old all.bat (diff)
downloadaes-tools-fc57a1fa4e0c74bcab836601cbd8677717b5064f.tar.gz
aes-tools-fc57a1fa4e0c74bcab836601cbd8677717b5064f.zip
add `make install`, `make test`, etc.
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 10 insertions, 22 deletions
diff --git a/README.md b/README.md
index adfc67d..23147b9 100644
--- a/README.md
+++ b/README.md
@@ -5,30 +5,18 @@ AES tools
Simple AES implementation and utilities.
-Building
---------
-
-Create the build files using CMake and build using your native build tools
-(Visual Studio/make/etc.).
+Development
+-----------
-* **Prerequisites.**
+Build using CMake.
Depends on Boost.{Filesystem,Program_options}.
-* **Customization.**
-The runtime libraries are linked statically by default.
-Therefore, the Boost libraries must also link them statically.
-You can link the runtime dynamically by passing `-D CC_STATIC_RUNTIME=OFF` to
-`cmake`.
-* **Example.**
-Using Visual Studio 2015 (targeting x86), build & install the release version
-to C:\aes-tools:
-
- > cmake -G "Visual Studio 14 2015" -A Win32 ^
- -D BOOST_ROOT=C:\path\to\boost ^
- C:\path\to\aes-tools
- ...
-
- > cmake --build . --config Release --target install -- /m
- ...
+
+There's a Makefile with useful shortcuts to build the project in the .build/
+directory along with the dependencies:
+
+ make deps
+ make build
+ make test
Usage on older CPUs
-------------------