diff --git a/src/getting-started.rst b/src/getting-started.rst index 5acec25..2cd2b5b 100644 --- a/src/getting-started.rst +++ b/src/getting-started.rst @@ -6,6 +6,16 @@ Getting started Getting started with ActivityWatch is as easy as installing, starting it, and setting up autostart (if your installation method doesn't do it for you). +System requirements +=================== + +The release builds are produced and tested on the following platforms. Older systems may work, but are not tested. + +- **Windows**: Windows 10 or later (x64; ARM64 builds are available for Windows 11). +- **macOS**: macOS 12 (Monterey) or later. Releases are built with a deployment target of 12.0, so older versions fail at launch with errors such as ``dyld: Library not loaded: libswift_Concurrency.dylib``. +- **Linux**: a distribution with glibc 2.35 or newer (the release is built on Ubuntu 22.04, so e.g. Ubuntu 22.04+, Debian 12+, Fedora 36+). Older distributions fail with ``GLIBC_2.xx not found`` errors; use a newer distribution or `build from source `_. +- **Android**: see the `Play Store listing `_ for the supported Android versions. + Installation ============ @@ -46,7 +56,7 @@ You should now also have the web interface running at ``_ and wi If you want more advanced ways to run ActivityWatch (including running it without aw-qt), check out the "Running" section of `installing-from-source`. .. 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`. + If you are running GNOME or another desktop environment that does not show system tray icons, install the `AppIndicator and KStatusNotifierItem Support `_ extension to get the tray icon back. If that is not an option, or if for some reason Qt can't be used on your machine, read `Running on GNOME`. .. 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/running-on-gnome.rst b/src/running-on-gnome.rst index 89c3aec..01938bf 100644 --- a/src/running-on-gnome.rst +++ b/src/running-on-gnome.rst @@ -1,6 +1,8 @@ Running on GNOME ================ +The ``aw-qt`` tray icon works on GNOME if you install the `AppIndicator and KStatusNotifierItem Support `_ extension (it ships by default in some distributions such as Ubuntu). If you can't or don't want to use it, read on. + As an alternative for users of GNOME 3 and other desktop environments that don't support app trays, or simply to avoid depending on Qt, you can place two simple workaround scripts in your ActivityWatch install folder: :code:`start.sh`: diff --git a/src/watchers.rst b/src/watchers.rst index bd2e1da..a73c3b1 100644 --- a/src/watchers.rst +++ b/src/watchers.rst @@ -28,7 +28,7 @@ Browser watchers Watches properties of the active browser tab like title, URL, audible and incognito state. -- :gh-aw:`aw-watcher-web` - The official browser extension, supports Chrome, Edge, and Firefox. +- :gh-aw:`aw-watcher-web` - The official browser extension, supports Chrome, Edge, and Firefox. Install it from the `Chrome Web Store `_ (Chrome and other Chromium-based browsers) or `Firefox Add-ons `_. Editor watchers ---------------