From 4edb52e7d53920880428804e9272cc556e1d9578 Mon Sep 17 00:00:00 2001 From: czjstmax Date: Fri, 21 Nov 2025 18:41:12 +0100 Subject: revise README for clarity and improved descriptions (commit generated by copilot on the gh website) updated the README to clarify the purpose and usage of 'g'. improved language for better readability. --- README.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 6c6f696..4b89dc2 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,19 @@ -# g -yes, that's the name of it. \ +g_repo-banner_565x200px + +# g — that's a short name. `g` is a simple `git` wrapper that you can use if \ you are as lazy as me and do not want write looong \ boooooooring commands like `git commit -a -m "fuck"`. -#### why "permissive"? -`g`'s whole logic is to be "permissive" with its \ -syntax so that it is fail-free, and also SHORT. +### why "permissive"? +`g`'s whole logic is to be "permissive" with its syntax making it \ +is fail-free, and also **very very** forgiving with its user. +### but what does it mean _practically_? +it means that you can write commands **however you like**, _within limitations_. \ +for example, all of these are valid commands to say "`git commit -a -m "hi"`" +* `g c a m "hi"` +* `g com a msg "hi"` + ## get `g` -~~to get `g` you can either build it yourself or you~~ \ -~~can install the AUR package `getg`.~~ -_note: you still technically cannot get `g` from the AUR_ \ -_because development is still ongoing and no AUR repo was_ \ -_created for it at the moment, please wait a bit :)_ +to get `g` you can either build it yourself or you \ +can install the AUR package `getg`. -- cgit v1.3.1