From 67b636100aae531958ee664d33ec7f5e6ad50f89 Mon Sep 17 00:00:00 2001 From: David Todd Date: Wed, 20 Feb 2019 19:37:45 -0600 Subject: [PATCH] Add readme --- README | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..301b4d5 --- /dev/null +++ b/README @@ -0,0 +1,12 @@ +autotyper, totally not nefarious at all. + +The only requirement other than stdlib is `keyboard`, which can be installed with `pip install -r requirements.txt`. It is recommended to run this in a virtualenv + +This is a simple program that takes the following arguments: `python main.py ` +* delay - This is the amount of time in seconds to wait between typing each character. Accepts float values to make it go fast +* filenames - All other arguments will be considered a file, and the script will attempt to read each one sequentially + +There is a kill switch that you can press at any time (F6), which will abort the script. +There is also a 5 second grace period before the program will start typing. + +License: MIT