changes in the script and README

Author: TWolczanski

README.md

@@ -1,6 +1,4 @@
-For some Linux users, especially those coming from Windows, scrolling through long PDFs or webpages is a real nightmare. On Windows you just click the middle mouse button to start scrolling and move your mouse to adjust the direction and speed.
-
-This is exactly what this simple Python script does. It gives you a Windows-like autoscroll feature on Linux. It works system-wide on every distribution with Xorg.
+This simple Python script gives you a Windows-like autoscroll feature on Linux. It works system-wide on every distribution with Xorg.
 
 ## Installation
 
@@ -10,17 +8,16 @@ git clone https://github.com/TWolczanski/linux-autoscroll.git
 ```
 2. Create a Python virtual environment and activate it:
 ```
-cd linux-autoscroll/
-python3 -m venv .venv
-source .venv/bin/activate
+python3 -m venv .autoscroll
+source .autoscroll/bin/activate
 ```
 3. Install pynput:
 ```
 python3 -m pip install pynput
 ```
-4. Add the following shebang to the script (substitute `/path/to/linux-autoscroll` with the actual path to your virtual environment):
+4. Add the following shebang to the script (substitute `/path/to` with the actual path to your virtual environment):
 ```
-#!/path/to/linux-autoscroll/.venv/bin/python3
+#!/path/to/.autoscroll/bin/python3
 ```
 5. Make the script executable:
 ```
@@ -32,9 +29,9 @@ chmod u+x autoscroll.py
 
 You can adjust the `DELAY` and `BUTTON` constants for better experience.
 
-By changing `DELAY` you can adjust the speed of scrolling. By default its value is 3 but you may find it either too fast or too slow. You can decrease the value to make scrolling faster or increase it to make scrolling slower.
+By changing `DELAY` you can adjust the speed of scrolling. By default its value is 5 but you may find it either too fast or too slow. You can decrease the value to make scrolling faster or increase it to make scrolling slower.
 
-Modifying `BUTTON` is going to change the button used for entering the scroll mode. The default is the middle mouse button but if your mouse has additional side buttons it might be a good idea to use one of them instead, as the middle button is often used for different purposes (for example to open a link in a new tab in most web browsers or to copy and paste text system-wide). As the script is using the pynput library, you can hopefully find the name of the side button with the following piece of code:
+Modifying `BUTTON` is going to change the button used for entering the scroll mode. The default is the middle mouse button but if your mouse has additional side buttons it might be a good idea to use one of them instead, as the middle button is often used for different purposes (for example to open a link in a new tab in most web browsers or to copy and paste text system-wide). As the script is using the pynput library, you can hopefully find names of all of your mouse buttons with the following piece of code:
 ```python
 from pynput.mouse import Button, Listener
 
@@ -47,4 +44,9 @@ def on_click(x, y, button, pressed):
 with Listener(on_click = on_click) as listener:
     listener.join()
 ```
-Then just replace `BUTTON = Button.middle` with `BUTTON = Button.name` where `name` is the name of the side button.
+
+## Usage
+
+Click the middle mouse button (or the button you have assigned to `BUTTON`) and move your mouse to start scrolling. The further you move the mouse (vertically) from the point where you clicked the button, the faster the scrolling becomes. To leave the scroll mode, simply press the button again.
+
+Note that at slow speed the scrolling is not smooth and (probably) there is no way to make it smooth. However, one can easily get used to it.

autoscroll.py

@@ -12,8 +12,8 @@ def on_move(x, y):
             direction = -1
         else:
             direction = 0
-        if abs(delta) < 20:
-            interval = DELAY / 20
+        if abs(delta) < DELAY * 2:
+            interval = 0.5
         else:
             interval = DELAY / abs(delta)
 
@@ -41,8 +41,11 @@ def autoscroll():
 pos = mouse.position
 direction = 0
 interval = 0
-DELAY = 3
+
+# modify this to adjust the speed of scrolling
+DELAY = 5
+# modify this to change the button used for entering the scroll mode
 BUTTON = Button.middle
 
 listener.start()
-autoscroll()
+autoscroll()