From 6842db64348c91310615608e1fbd24d0e57959af Mon Sep 17 00:00:00 2001 From: Leon Etienne Date: Sat, 8 Aug 2026 17:01:47 +0200 Subject: [PATCH] professionalize wording --- GCryptLib/doxygen/doxyfig | 2 +- readme.md | 19 ++++++++----------- 2 files changed, 9 insertions(+), 12 deletions(-) diff --git a/GCryptLib/doxygen/doxyfig b/GCryptLib/doxygen/doxyfig index d6ed63c..1ee4090 100644 --- a/GCryptLib/doxygen/doxyfig +++ b/GCryptLib/doxygen/doxyfig @@ -44,7 +44,7 @@ PROJECT_NUMBER = # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. -PROJECT_BRIEF = "Ghetto (but also super easy) cryptography!" +PROJECT_BRIEF = "An educational cryptography library (GCrypt / GNU Crypt)" # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 diff --git a/readme.md b/readme.md index 9c2fe6f..bced0da 100644 --- a/readme.md +++ b/readme.md @@ -1,24 +1,22 @@ [![Build Status](https://drone.leonetienne.de/api/badges/leonetienne/GCrypt/status.svg)](https://drone.leonetienne.de/leonetienne/GCrypt) # GCrypt -*(GhettoCrypt), because frankly I have no idea what the fuck I'm doing* +*GCrypt (GNU Crypt) — an educational project for learning how block ciphers work* *Please don't use this for anything critical* +> **Note:** This project is unrelated to [libgcrypt](https://www.gnupg.org/software/libgcrypt/index.html), the cryptographic library used by GnuPG. Any naming similarity is coincidental — "GCrypt" here just stands for "GNU Crypt". + ## [Documentation](https://gcrypt.rtfm.leonetienne.de/) -## What the hell is this? +## What is this? An educational project on implementing a block cipher using a feistel network. This block cipher employs a few modes of operation. Read more about them [here](#modes-of-operation). ## Features -* It has very easy syntax -* It's slow -* It's probably super insecure -* But the syntax is pythonlike easy🙇 +* Very easy to use * 512-bit keys - -It's pretty ghetto, you know? +* Not performance-optimized, and not audited for security ## What are the actual advantages? * It's two files to import into your project @@ -30,9 +28,8 @@ It's pretty ghetto, you know? * For data obfuscation * If your only other option would be no encryption at all -### I am not kidding, don't use this for critical stuff! Homebrew ciphers tend to be shit! -Especially mine!🗡️ -Even assumed it's a good cipher, it's implementation leaves a lot to be desired in terms of being cryptographically secure. +### Seriously, don't use this for anything critical. Homebrew ciphers are rarely secure — this one included. +Even assuming it's a good cipher, its implementation leaves a lot to be desired in terms of being cryptographically secure. ## How do I use this? ### *"I don't care about the library. Just let me use it from the command line!"*