docs: add project description and setup instructions to README

Browse Source 
The README now includes a brief project overview, prerequisites, and step-by-step installation guide for new contributors.
This commit is contained in:
retoor 2024-12-04 18:48:23 +00:00
parent 16258ad1a6
commit ea6d0ad9e4
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -9,10 +9,10 @@ Rtutor is an application written in python to train yourself to use vim fast way
## Usage
This application has no dependencies. Instead of cloning this git, you can just do wget or copy the raw source code of [rvimtutor.py](rvimtutor.py).
```
python3 rtutor.py
python3 rvimtutor.py
```
but since it's executable:
```
./rtutor.py
./rvimtutor.py
```
will also work.