summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md42
1 files changed, 38 insertions, 4 deletions
diff --git a/README.md b/README.md
index d3a2b00..a89023f 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,41 @@
-# anyscroll
+# Anyscroll
+### Scroll anywhere in your x11 environment by clicking and dragging!
-Scroll anywhere in your x11 environment by clicking and dragging!
-This program was heavily inspired by the browser extension [scroll anywhere](https://fastaddons.com/#scroll_anywhere)
+![License](https://img.shields.io/github/license/davidovski/anyscroll)
-still in development
+
+This program was heavily inspired by the browser extension [scroll anywhere.](https://fastaddons.com/#scroll_anywhere)
+
+## How to install
+
+### Dependencies:
+- ```x11``` to run your environment
+- ```libxtst-dev``` to emulate scrolling
+- (Optional) ```git``` to clone the repository
+
+### Instructions:
+- Clone this repository with\
+ ```git clone https://github.com/davidovski/anyscroll``` or by downloading and extracting the .zip file
+- Enter into the directory with ```cd anyscroll```
+- Type ```make``` to install
+
+## How to use
+
+A binary has now been created in your anyscroll directory. To run it, type ./anyscroll. If you want it to run on startup, add ./anyscroll to your startup.
+
+And thats it! simply hold down you middle mouse button and move your mouse up or down to scroll.
+
+Note: _there is currently a feature in many linux distros where the middle mouse button copies from your clipboard. This can be ignored in most websites or apps, but sometimes it can get pretty annoying. I am working to fix this issue, and if you have a solution, please contribute._
+
+## Development
+
+This project is still being actively developed and has many more features coming soon.
+
+## How to contribute
+
+To contribute, you can open a new pull request on GitHub, and if I like the code, I will accept it.
+
+## License
+
+The code is registered under the GPL license, making it open-source. Please read the license to understand what you can and cannot do with this software. \ No newline at end of file