updated readme

This commit is contained in:
Prashant Gupta 2019-04-11 17:31:23 -07:00 committed by GitHub
parent 2e7a4233b1
commit 07ffcd8286
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 27 additions and 5 deletions

View File

@ -1,16 +1,38 @@
## Presenting the minimalistic Automatic-Mouse-Mover(AMM) app! ## Presenting the minimalistic Automatic-Mouse-Mover(AMM) app!
![GitHub release](https://img.shields.io/github/release/prashantgupta24/automatic-mouse-mover.svg) ![GitHub release](https://img.shields.io/github/release/prashantgupta24/automatic-mouse-mover.svg)
[![Go Report Card](https://goreportcard.com/badge/github.com/prashantgupta24/automatic-mouse-mover)](https://goreportcard.com/report/github.com/prashantgupta24/automatic-mouse-mover)
Ever felt the need to keep your machine awake without having to resort to the age-old methods of playing a video or installing an app that you don't trust? **Well, not anymore!** Ever felt the need to keep your machine awake without having to resort to the age-old methods of installing an app that you don't trust or playing a video? **Well, not anymore!**
> Introducing the simplest app on the market that has the sole purpose of moving your mouse pointer at regular intervals so that your machine never sleeps! And best of all, it works **ONLY** when you are not working, so be rest assured that the mouse won't start moving on its own without the machine actually being idle. Introducing the simplest app on the market that has the sole purpose of moving your mouse pointer at regular intervals so that your machine never sleeps! And best of all, it works **ONLY** when you are not working, so be rest assured that the mouse won't start moving on its own without the machine actually being idle.
## Demo
## Error while running the app You just click on `Start`, and AMM will take care of moving your mouse whenever it feels that the system has been left idle for a long time. It's as simple as this.
In case you get an error from the app saying `mouse pointer cannot be moved.`, you need to give the app permission to control your mouse. Don't worry, it's nothing sinister, but Mac doesn't allow apps to gain accessibility to the computer by default (even standard apps like Automator, Firefox etc. who might want to access some features need to go through the same process) ![](https://github.com/prashantgupta24/automatic-mouse-mover/tree/master/resources/amm-demo.gif)
## How to install
Make sure you have `go` installed. Once that is done, clone this repo and run `Make`, it should create the `amm.app` and open the folder where it was built for you. You just have to drag and drop it to the `Applications` folder on your mac.
Double click on the app, and the cute `mouse` should appear on your taskbar on top of your screen. Once you click on `Start`, you might encounter an initial `Access request` which I've discussed in the next section. If not, then you are all set!
## Granting access for moving the mouse cursor
While starting the app, you might see a message like the one below or an error stating `Mouse pointer cannot be moved`.
![](https://github.com/prashantgupta24/automatic-mouse-mover/tree/master/resources/request.jpg)
Don't worry, it's nothing sinister, it's just that Mac doesn't allow apps to gain accessibility to the computer by default (even standard apps like Automator, Firefox etc. who might want to access some features need to go through the same process).
In order to resolve this error you need to: In order to resolve this error you need to:
> Go to Security & Privacy -> Privacy -> Accessibility and allow the `amm` app to gain access. > Go to System Preferences -> Security & Privacy -> Privacy -> Accessibility and allow the `amm` app to gain access.
## How it works
Every 60 seconds, AMM uses [Activity tracker](https://github.com/prashantgupta24/activity-tracker) to track the various changes that happened in your system during that time, like cursor movement, mouse clicks, screen changes etc. Whenever `AMM` detects a change in the system, it knows that the system is busy and will not do anything. If not, it moves the mouse cursor ever so slightly, enough to keep your Mac awake for eternity.
> All code is public and open-sourced so no worrying if there's nefarious intention involved in recording your activity or not.

BIN
resources/amm-demo.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.8 MiB

BIN
resources/request.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB