diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 000000000000..9006b91ffc34 --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +# Pytimer +This is a simple terminal based python script that lets you set a timer of any length. +If you find issues, please report them on the issue tracker. + +# OS support: + <ul> + <li> + GNU/Linux + </li> + <li> + MacOS + </li> + <li> + Windows + </li> + </ul> + +# Features: + <ul> + <li> + Hours + </li> + <li> + Minutes + </li> + <li> + Seconds + </li> + </ul> + +# Installation instructions: + <ul> + <li> + Simply download the file "pytimer.py" and run it through the terminal. + </li> + <li> + There is also an installer script for linux and MacOS that will try to put the file into your /usr/bin/ directory along with an executable script that makes it available as a command. + Windows installer unsupported, but I might make it to learn how to make one. + If you opt for the script, dont run it as super user (i.e. runnign "sudo pytimer-install.sh"), becuase then the script won't be able to install the files into the proper directories. + </li> + </ul> + +# Known issues: + <ul> + <li> + Entering no values results in error. I will fix this when I find time and or motivation. + </li> + </ul> |