diff --git a/README.md b/README.md index 377526e..9eef91b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,29 @@ # autoclick -Go auto-clicker \ No newline at end of file +Go auto-clicker that stores groups of locations. +Based on [Robotgo](https://github.com/go-vgo/robotgo). + + +## Installation + +Depending on your OS, you may require +[different dependencies](https://github.com/go-vgo/robotgo?tab=readme-ov-file#requirements). + +If you are running MacOS, you just need to install Xcode Command Line Tools +and grant Go the accessibility permissions when prompted from the system. + +```sh +xcode-select --install +``` + +Finally, once dependencies are met, to install autoclick run: + +```bash +go install gogs.davte.it/Davte/autoclick@latest +``` + +To launch autoclick from any path, add this to your bash profile or bashrc: + +```bash +export PATH="$PATH:/$HOME/go/bin" +``` \ No newline at end of file