diff --git a/README.md b/README.md index dfa8b70..06b88b2 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,7 @@ A multi-purpose Cryptography library in Java. Working on it day by day, slowly. Someday this will be complete, today is not that day. -To be clear, this is **NOT** mean't to be a replacement/alternative to BouncyCastle. Instead, it is meant to include what BouncyCastle does not have. I do not take any code whatsoever from OpenSSL or BouncyCastle for that reason. +To be clear, this is **NOT** mean't to be a replacement/alternative to BouncyCastle. Instead, it is meant to include what BouncyCastle does not have. No code was taken from OpenSSL or BouncyCastle for that reason. -### Current Objective: ZekerRijndael (custom from-scratch AES-128 block cipher) -### Note: i'm creating ZekerRijndael as it can be used for creating the following encryption ciphers: AES-CTR; AES-OFB; AES-CFB. Block modes include AES-CBC; AES-ECB. And of course AES-GCM + ASE-CCM -### if i ever say 196-bit, i mean 192-bit my brain is just bugged lol -## View the "zekerRijndael" branch to see inprogress work. - -(i keep confusing myself so here's a todo) TODO: -### BLOWFISH-ECB -### BLOWFISH-CBC -### ARIA-ECB -### ARIA-CBC -### ARIA-CFB -### ARIA-OFB - -### Current Objective: ZekerRijndael (custom from-scratch AES-128 block cipher) - -## View the "zekerRijndael" branch to see inprogress work. +### Current Objective: ZekerRijndael (custom encryption sub-library) Use `setopt interactivecomments` (zsh only) to allow using `#` for comments if you see errors like `zsh: command not found: #` @@ -24,10 +9,10 @@ Ensure Java + javac are installed, on MacOS it can be installed with Homebrew by You will also need maven installed. With Homebrew, this can be installed with `brew install maven`. -To compile: +To compile (these commands should work universally): 1. git clone https://github.com/Geprivilegieerde-Anonimiteit-BV/XACrypto.git # download the git repository -2. cd XACrypto -3. mvn clean package +2. cd XACrypto # enter the directory +3. mvn clean package # compile the package cleanly You should find the built jar at target/XACrypto-1.0-SNAPSHOT.jar