updated readme (#15)
* updated readme * updated readme Co-authored-by: Prashant Gupta <prashantgupta@us.ibm.com>
This commit is contained in:
Prashant Gupta
GitHub
parent
bbb4f62a5a
commit
5d04b332da
25
README.md
25
README.md
|
|
@ -1,13 +1,13 @@
|
|||
## Presenting the minimalistic Automatic-Mouse-Mover(AMM) app!
|
||||
|
||||
[![version][version-badge]][RELEASES] [](https://goreportcard.com/report/github.com/prashantgupta24/automatic-mouse-mover) [![godoc-badge][godoc-badge]][godoc-link] [](https://codecov.io/gh/prashantgupta24/automatic-mouse-mover)
|
||||
|
||||
[![version][version-badge]][releases] [](https://goreportcard.com/report/github.com/prashantgupta24/automatic-mouse-mover) [![godoc-badge][godoc-badge]][godoc-link] [](https://codecov.io/gh/prashantgupta24/automatic-mouse-mover)
|
||||
|
||||
Ever felt the need to keep your machine awake without having to resort to the age-old methods of installing an app that hinders with your mac's sleep mechanism or playing a never-ending 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.
|
||||
|
||||
## How I use it
|
||||
|
||||
I always have this app working in the background for me whenever I work from home, so that I can take a break from work, strech my legs, go for a short walk, come back and still have my slack open! (not having to type in my password every time is awesome).
|
||||
|
||||
Also if I need to go out for longer, I just close the lid, and off goes my mac to sleep!
|
||||
|
|
@ -20,15 +20,27 @@ So if you want something that will keep your mac awake as long as you are workin
|
|||
|
||||
## Demo
|
||||
|
||||
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 minute. It's as simple as this.
|
||||
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 minute. It's as simple as this.
|
||||
|
||||
|
||||
|
||||
## 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.
|
||||
### Install from binary
|
||||
|
||||
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!
|
||||
1. Download the latest `amm.app.zip` from the [releases](https://github.com/prashantgupta24/automatic-mouse-mover/releases) page, unzip it, and copy the .app to your `Applications` folder like any other application.
|
||||
|
||||
1. Since the application is not notarized, you will need to right click on the .app and choose Open.
|
||||
|
||||
1. You will see a scary message that warns you about all the bad things that the app can do to your computer. If you are paranoid (fair enough, you don't really know me that well) then you can skip to the section which builds the app from source. That way you can see what exactly the app does (You can check that the application makes no connections to the internet whatsoever).
|
||||
|
||||
1. In case you do trust me, once you click on `Open`, you might encounter an initial `Access request` which I've discussed in the next section.
|
||||
|
||||
### Install from source
|
||||
|
||||
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. Copy the .app to your `Applications` folder like any other application.
|
||||
|
||||
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
|
||||
|
||||
|
|
@ -51,7 +63,6 @@ Every 60 seconds, AMM uses [Activity tracker](https://github.com/prashantgupta24
|
|||
> All code is public and open-sourced so no worrying if there's nefarious intention involved in recording your activity or not.
|
||||
|
||||
[version-badge]: https://img.shields.io/github/release/prashantgupta24/automatic-mouse-mover.svg
|
||||
[RELEASES]: https://github.com/prashantgupta24/automatic-mouse-mover/releases
|
||||
|
||||
[releases]: https://github.com/prashantgupta24/automatic-mouse-mover/releases
|
||||
[godoc-badge]: https://img.shields.io/badge/godoc-reference-blue.svg
|
||||
[godoc-link]: https://godoc.org/github.com/prashantgupta24/automatic-mouse-mover/pkg/mousemover
|
||||
|
|
|
|||
Loading…
Reference in New Issue