added installation guide and updated license in setup.py

This commit is contained in:
Doman 2021-07-11 13:33:40 +02:00
parent 9ff9662b7e
commit 80d840a75a
2 changed files with 8 additions and 2 deletions

View file

@ -5,13 +5,19 @@
_Fasttyper_ is minimalistic typing test based on user provided exercising text. It supports both reading from text files and stdin supporting wide range of usecases. The goal was to create it as simple as it can be, without any additional bloatware functionalities. That means that _Fasttyper_ doesn't come with build in test generator and you have to provide your own scripts generating tests. Some examples of such scrips are providen in [Usage section](#usage).
# Installation
_Fasttyper_ is currently maintained on [TestPyPi](https://test.pypi.org/) Python Package Index. To install package simpply use:
`python3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps fasttyper-pkg-ickyicky`
# Usage
_Fasttyper_ is ran as an python module, so to execute it simply type:
`python3 -m fasttyper`
from cloned github repository. Without any argument program waits for user to enter text manually and then signal the end of it with keyboard interrupt (CTRL+C). _Fasttyper_ can open text files, which path should be provided as first and only argument to the module execution, for example:
from cloned github repository, if you didn't [install](#installation) package from TestPyPi. Without any argument program waits for user to enter text manually and then signal the end of it with keyboard interrupt (CTRL+C). _Fasttyper_ can open text files, which path should be provided as first and only argument to the module execution, for example:
`python3 -m fasttyper example_text.txt`

View file

@ -14,7 +14,7 @@ setup(
url="https://github.com/ickyicky/fasttyper",
classifiers=[
"Programming Language :: Python :: 3",
"License :: GPLv3+",
"License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
"Operating System :: OS Independent",
],
packages=find_packages(),