diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 18b1954..fe4a294 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -17,7 +17,7 @@ jobs: - name: Set up Python uses: actions/setup-python@v1 with: - python-version: 3.8 + python-version: 3.12 - name: Install APT dependencies run: | sudo apt-get install -y git build-essential apt-utils wget libfreetype6 libpng-dev libopenblas-dev gcc gfortran libsnappy-dev diff --git a/src/getting-started.rst b/src/getting-started.rst index 5e67a12..ad56316 100644 --- a/src/getting-started.rst +++ b/src/getting-started.rst @@ -24,7 +24,7 @@ Installation Download the `latest release from GitHub `_, unzip the archive into an appropriate directory, and add the ``aw-qt`` executable to your autostart applications. .. note:: - If you are using Arch Linux you can install ActivityWatch directly from `the AUR `_. + If you are using Arch Linux you can install using the official ``activitywatch-bin`` package in `the AUR `_. .. group-tab:: Android @@ -33,6 +33,10 @@ Installation .. note:: Getting it to F-droid is a work-in-progress, see `this PR `_. + .. group-tab:: Source + + If you prefer to build ActivityWatch from source, check out :doc:`this guide ` instead. + Usage ===== @@ -48,6 +52,9 @@ If you want more advanced ways to run ActivityWatch (including running it withou .. note:: If you are running GNOME 3 or another desktop environment that does not support system trays, or if for some reason Qt can't be used on your machine, read `Running on GNOME`. +.. note:: + If your Linux system is using Wayland rather than X11, the default watchers will not work. See :ref:`wayland watchers `. + .. note:: If you are using a proxy ActivityWatch might not work out of the box. To fix this you can set the environment variable ``NO_PROXY`` to include ``127.0.0.1`` before starting aw-qt. How to set an environment variable depends on your operating system; use Google if you are unsure how to do this. diff --git a/src/watchers.rst b/src/watchers.rst index 547115e..b64fe49 100644 --- a/src/watchers.rst +++ b/src/watchers.rst @@ -3,7 +3,13 @@ Watchers Watchers are the parts of ActivityWatch that do all the data collecting. -ActivityWatch comes with two watchers enabled by default: + +.. _window-watchers: + +Window watchers +------------------------------------------- + +ActivityWatch comes with two watchers enabled by default supporting Windows, macOS and Linux (X11 only): - :gh-aw:`aw-watcher-afk` - Watches for mouse & keyboard activity to detect if the user is active (by default, an inactive period of at least 3 minutes is flagged as AFK: away from keyboard). - :gh-aw:`aw-watcher-window` - Watches the active window, its title, and it's url (on Chrome-based browsers & Safari). @@ -11,16 +17,16 @@ ActivityWatch comes with two watchers enabled by default: These default watchers are collecting some of the most important data. But there is more to collect, so here are some other watchers that let you do so. -.. _window-watchers: +.. _wayland-watchers: -Window watchers ---------------- +Wayland watchers +------------------------------------------- -Watches the active window, its title, and application name. +Replaces :gh-aw:`aw-watcher-window` and :gh-aw:`aw-watcher-afk` to support Wayland, see issue :issue:`92`. -- :gh-aw:`aw-watcher-window` - The official window watcher for Windows, macOS, and Linux (X11 only). -- :gh-aw:`aw-watcher-window-wayland` - A window watcher for Wayland, by :gh-user:`johan-bjareholt`. -- :gh:`2e3s/awatcher` - A compiled watcher for X11 and Wayland to replace default window and AFK watchers, by :gh-user:`2e3s`. +- :gh-aw:`aw-watcher-window-wayland` - A window and idle watcher for Wayland, by :gh-user:`johan-bjareholt`, supports Posh, Sway. +- :gh:`2e3s/awatcher` - A compiled window and idle watcher for X11 and Wayland to replace default window and AFK watchers, + by :gh-user:`2e3s`, supports Sway, Hyprland, KDE, GNOME, and X11. Browser watchers ----------------