Skip to content

Commit

Permalink
Add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
congnd committed Jun 14, 2020
1 parent 1ae06b5 commit 8b6a155
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
/MiMoSimApp.xcodeproj/project.xcworkspace/xcuserdata/
/MiMoSimApp.xcodeproj/xcuserdata/
/dist
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
![MiMoSim](/resources/Banner.png)

[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)

MiMoSim is a tiny macOS app that allows you to scroll content in an interesting way.

## Feature
Scroll content by moving the mouse in a circular path.

## Installation
- Download the MiMoSim app from the release page or you can build from source code
- Double-click to run MiMoSim
- Since MiMoSim listens to the keyboard events (to understand when you want to start and end a scroll session) and mouse events (to understand which direction and how fast scroll do you want), you will be asked to give MiMoSim accessibility privilege. Open your System Preferences → Privacy → Accessibility, and grant accessibility privilege to MiMoSim by checking MiMoSim item on the list.
- Double-click again to run MiMoSim
- Now you will see a small MiMoSim icon in the system's status bar
- Start using MiMoSim

## Usage
- Press and hold the control key (the mouse now is in P1 position on the screen)
- Move the mouse in any direction a short distance ~ 50pt
- Then you will see the scrolling wheel appears with P1 as its center point.
- Now move the mouse in a circular path, and you will see the content under the mouse being moved in sync with your mouse movement.
- Move your mouse in the clockwise (CW) direction to scroll up, and counterclockwise (CCW) direction to scroll down.
- Release the control key to finish

***Watch this video for more detail:***
<iframe width="560" height="315"
src="https://www.youtube.com/watch?v=VlE2XT3h_F8"
frameborder="0"
allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen></iframe>

## FAQ
### How to terminate MiMoSim?
Select the MiMoSim icon in the status bar and select Quit.

## Author
[@congnd](https://github.com/congnd)

## License
MiMoSim is released under the MIT license. See LICENSE for details.
Binary file added resources/AppIcon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/Banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8b6a155

Please sign in to comment.