Add README

2024-08-23 00:39:09 +02:00
parent 48a73d846d
commit ef9638ce29
1 changed files with 26 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,26 @@
+
+# Vigenère cipher solver
+
+Uses index of coincidence and frequency analysis to find Vigenère cipher keys
+from ciphertexts
+
+## Build
+
+```bash
+make
+```
+
+## Example usage
+
+```
+./build/solve txt/shakespeare-encrypted.txt | head -c 1024
+```
+
+## References
+
+[Vigenère cipher](https://en.wikipedia.org/wiki/Vigen%C3%A8re_cipher)
+
+[Index of Coincidence](https://en.wikipedia.org/wiki/Index_of_coincidence)
+
+[Frequency analysis](https://en.wikipedia.org/wiki/Frequency_analysis)
+