diff --git a/README.md b/README.md index ba049d8..fe3c10f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,13 @@ # LinVAM Linux Voice Activated Macro +##Status +This project is currently a work-in-progress and is minimally functional. +##Dependencies +- PyQt5 +##Install +- $sudo git clone https://github.com/rose-jinyang/LinVAM.git +##Usage +This script must be run with root privilege because it must hook and simulate input devices such as keyboard, mouse etc. +- $cd LinVAM +- $sudo python ./main.py +