mirror of https://github.com/n05la3/cmdtypist
updated README
Calson Noah
7 years ago
parent
fc4e1a6e36
commit
053d7d72aa
@ -1,101 +1,102 @@
|
||||
CMDTYPIST
|
||||
---------
|
||||
# CMDTYPIST -- _Command Line Typing Tutor_
|
||||
|
||||
It is a programmer oriented command line typing tutor written in c,
|
||||
designed to work on the gnome-terminal, xterm and uxterm and other consoles. It
|
||||
consists true programming lessons, so the user can type and learn at the same time.
|
||||
#### By _Chiatiah Calson_
|
||||
|
||||
License
|
||||
-------
|
||||
### About
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
_Cmdtypist_ is a programmer oriented typing tutor written in _C_,
|
||||
designed to work on the gnome-terminal, xterm and uxterm and other consoles. It
|
||||
consists true programming lessons, so the user can type and learn at the same time.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
### DOWNLOAD
|
||||
|
||||
Author
|
||||
------
|
||||
You can get cmdtypist by cloning the repo from github
|
||||
|
||||
git clone https://github.com/Noslac/cmd_typist
|
||||
|
||||
Chiatiah Calson
|
||||
### INSTALLATION
|
||||
|
||||
General Features
|
||||
----------------
|
||||
Open a terminal and navigate to the directory containing cmdtypist and all
|
||||
it's files. Navigate to cmdtypist directory called installation and run
|
||||
|
||||
Extremely fast, never again type faster than your type tutor!!!
|
||||
./install.sh
|
||||
|
||||
CMDTYPIST comes bundled with a good number of lessons for both programmers
|
||||
and non-programmers. The non programmer lessons help train the user on
|
||||
basic typing techiques and the programmer lessons help both the programmer
|
||||
and non programmers to become better at typing.
|
||||
to install cmdtypist
|
||||
|
||||
An accurate speed algorithm in character per minute (CPM) and an approximate
|
||||
in word per minute WPM (accuracy -+0.35)
|
||||
### RUNNING
|
||||
|
||||
Terminal is manipulated to print green a correct character and red a wrong
|
||||
character. This makes cmdtypist command line tutor very appealing. The user
|
||||
easily knows where he has gone wrong and can undo all errors.
|
||||
|
||||
Keeps a record of the number of wrong and correct characters; cmdtypist is able
|
||||
tracks the number of wrong characters and displays at the end of each session.
|
||||
If _install.sh_ exited with a success message, then you have installed cmdtypist,
|
||||
you can then run the command
|
||||
|
||||
Creates a text file to keep a account of the user speed in details(date,
|
||||
numer of errors, speed in CPM and WPM and time elapsed) for each session. Hence,
|
||||
the user can always keep track of his typing speed from the very first day.
|
||||
cmdtypist arg1 arg2 arg3 ...
|
||||
|
||||
NOTE: cmdtypist makes a periodic check once a month, on the size of the
|
||||
speed.info file, and when it has reached a certain length, on a confirmed prompt
|
||||
will automatically rename or delete the the existing file and hen create a new one.
|
||||
from any directory. _arg1, arg2,..._ are valid cmdtypist arguments,
|
||||
to know all valid arguments, run the cmdtypist help command or consult the help
|
||||
file which comes with the program. If you are a first time user, after installing cmdtypist, you must run the command **_cmdtypist mkuser "username"_** to create a user called username.
|
||||
|
||||
### CMDTYPIST ARGUMENTS
|
||||
|
||||
CMDTYPIST equally contains a "myown.txt" file, where a user can input an optional
|
||||
text he wants to type. With myown.txt, the user is limited to typing only in
|
||||
standard mode.
|
||||
_cmdtypist_ commands are entered at the terminal with the exception of **_select "lesson-number"_** (_lesson-number is an int corresponding to a valid lesson number_) which is entered at the cmdtypist prompt prior to some other cmdtypist command entered at the terminal.
|
||||
|
||||
CMDTYPIST Commands | Description
|
||||
------------ | -------------
|
||||
**cmtypist --help** | Displays help menu
|
||||
**cmtypist**| Displays lessons and opens the cmdtypist prompt
|
||||
**cmdtypist mkuser "username"** | Creates a new user called username
|
||||
**cmtypist ls** | Lists available lessons, use <select "lesson-number"> to select a lesson
|
||||
**cmtypist man** | Displays cmdtypist readme file
|
||||
**cmdtypist select** "lesson number" | Used to select a lesson directly from terminal
|
||||
**cmtypist atv**| Use this command if backspace is not working properly
|
||||
**cmdtypist sound --on** | Activates error beep sound
|
||||
**cmdtypist sound --off** | Deacativates beep sound
|
||||
**cmdtypist /myown** | Changes the lessons to user's lesson copied into myown.txt
|
||||
**cmtypist cchl** | Exits from user's lesson mode
|
||||
**cmdtypist mkstd** | Lessons appear as they are in lesson file
|
||||
**cmdtypist mkrand** | Lessons appear randomly
|
||||
**cmdtypist chblock "lesson number"** | changes number of lines per sesson to an int 'lesson number'
|
||||
**cmdtypist reset** | Does a soft reset
|
||||
**cmdtypist reset raw** | Does a hard reset, resetting to default
|
||||
|
||||
Command Line Features
|
||||
---------------------
|
||||
Consult help file for more details of these commands
|
||||
|
||||
The user can choose to type in random mode where a random block is each
|
||||
session is chosen from selected lesson.
|
||||
|
||||
And in standard mode, the user types chronologically as the lesson is in
|
||||
the lesson file.
|
||||
### UNINSTALL
|
||||
|
||||
The user can chose to modify any lesson in the lesson file easily.
|
||||
If you are having problems with cmdtypist configurations, you can run the
|
||||
command
|
||||
|
||||
cmdtypist reset raw
|
||||
|
||||
For a user who will not love to modify the lesson file, a my_own.txt file
|
||||
is available for the user to paste his text file he wants to type.
|
||||
to reset settings to default. But if you want to permanently uninstall cmdtypist,
|
||||
proceed below.
|
||||
|
||||
NOTE: Text file should contain only ascii 7 bits characters. For this reason,
|
||||
user text may some times look absurd when contains extended ascii characters
|
||||
since program has a function to ignore such characters.
|
||||
To uninstall cmdtypist, open a terminal and cd into directory containing the
|
||||
unintall script by running
|
||||
|
||||
User also can choose to receive a beep for any wrong character typed (may
|
||||
not work on all terminals)
|
||||
cd $HOME/cmdtypist/uninstall/
|
||||
|
||||
Program has the ability to remember all past settings.
|
||||
finally, run
|
||||
|
||||
Terminal is manipulated so a user can erase characters right to the beginning
|
||||
of the session line(timing reset) For each wrong character erased, number of
|
||||
errors is decremented by one.
|
||||
./uninstall
|
||||
|
||||
User session timing starts only when he types a first character (wrong or
|
||||
correct)
|
||||
to completely remove cmdtypist and associated files.
|
||||
|
||||
If the user erases to the beginning of the session, time is reset to zero
|
||||
and starts only as described above.
|
||||
|
||||
The last line of each lesson session is marked blue, so user is aware and
|
||||
can take time to review speed details befor estarting the following lesson.
|
||||
### License
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
|
||||
Loading…
Reference in New Issue