docs: Create documentation for argon2 library

Alexandre Vanhecke 2017-10-22 16:09:21 +02:00
parent 08918371b8
commit 059436af47

@ -0,0 +1,23 @@
## Compile and install argon2 library on a linux os based :
```bash
git clone https://www.github.com/P-H-C/phc-winner-argon2.git argon2-src;
cd argon2-src && sudo make && sudo make install;
```
## Compile and install argon2 library on Windows :
**IN THEORY : Install [MINGW for Windows](https://sourceforge.net/projects/mingw/files/Installer/) and [Git Bash for Windows](https://git-for-windows.github.io/), open a git bash _as Administrator_ somewhere, and do as follow:**
```
git clone https://www.github.com/P-H-C/phc-winner-argon2.git argon2-src ;
cd argon2-src && make && make install;
```
We wrote IN THEORY cause the Makefile tell to do with MINGW but we cannot test the compilation correctly
## Modify your authme config.yml :
```yaml
password_encryption:
encryption_algorithm: ARGON2
```