From 80d840a75a5fc8615bca014556fa75dfd0b27f9f Mon Sep 17 00:00:00 2001 From: Doman Date: Sun, 11 Jul 2021 13:33:40 +0200 Subject: [PATCH] added installation guide and updated license in setup.py --- README.md | 8 +++++++- setup.py | 2 +- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c6f9c95..22df528 100644 --- a/README.md +++ b/README.md @@ -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` diff --git a/setup.py b/setup.py index 5084e54..a713c48 100644 --- a/setup.py +++ b/setup.py @@ -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(),