diff --git a/README.md b/README.md index 36cd69d..22e602e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,23 @@ -# just_simple_cryptography +Simple cryptography mini-libraries for C++ and Python. +Just work. -Simple cryptography mini-libraries for C++ and Python. -Just work. \ No newline at end of file +## How to use +1. Install `make` (watch your distro package) +2. Install botan2 [as in wiki](https://botan.randombit.net/handbook/) / [in git](https://github.com/randombit/botan) / [install from your distro.](https://github.com/randombit/botan/wiki/Distros) +3. Run examples with make: +* C++ all: `make` +* C++ build: `make build` +* C++ run: `make run` +* Python: `make run_python` + +## If you have trouble (with install botan) and you on Debian +1. Install botan2 from repo: +* Download botan2 from repo https://github.com/randombit/botan (BOTAN2!!!, NOT 3) +* Join inside folder +* `python configure.py --prefix=/usr/local` +* `make -j4` (-j4 is 4 threads) +* `make install` (with root) +2. Install packages from repo: `apt install botan libbotan-2-dev python3-botan` + +## If you have trouble with finding libs +You SHOULD set `BOTAN_PATH` and `LD_LIBRARY_PATH` by YOURSELF if you have trouble (`mlocate` will help you: `updatedb`, `locate botan-2` and etc) \ No newline at end of file