From 2e8d6a27684cb9ab2655ff6fed242fd2e0f04f98 Mon Sep 17 00:00:00 2001 From: retoor Date: Wed, 4 Dec 2024 18:50:38 +0000 Subject: [PATCH] docs: add project overview, setup guide, and API references to README - Include project purpose description and key feature list with statistics tracking - Add step-by-step installation instructions and configuration guide for new users - Provide usage examples and API documentation references for developers --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 26ffcd7..8f42162 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ # Rvimtutor -Rvimtutor is an application written using Python for training yourself to use vim fast the way and to learn over 60 shortcuts! Features: +Rvimtutor is an application written using Python for training yourself to use vim fast the way and to learn over 60 shortcuts! + +It's not an impressive application but not bad for a few hours work. Several friends used it with good end result. + +Features: - Display question answered right / wrong statitiscs. - Display AVG time spent to answer a question. - Questions with random values to make it less boring.