Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 50 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,52 @@

**Forked** from https://github.com/scottkirkwood/key-mon (original author:
`scottkirkwood <https://github.com/scottkirkwood>`_ )

=======
Key-Mon
=======
Useful for screencasting or recording utility that displays your live keyboard and mouse activity (Xorg only, no Wayland)

.. image:: ./docs/keymon.gif
:alt: Key-Mon capabilities

Changes:
-------

* Added dependencies in setup.py

* Changed README.rst

* Added the binary AppImage file, as well as the script make-appimage.sh that was used to create it

Installation:
-------------
On Ubuntu/Mint/Debian systems - install required packages:::

$ sudo apt-get update

$ sudo apt-get install -y python3-xlib python3-gi python3-gi-cairo gir1.2-gtk-3.0 cmake libcairo2-dev libgirepository1.0-dev

::

$ git clone 'https://github.com/setaur/key-mon'

$ cd key-mon/

$ pipx install .

Or download the Appimage file from the https://github.com/setaur/key-mon/releases and run it:::

$ wget https://github.com/setaur/key-mon/releases/download/v1.20-fork/Key-Mon-x86_64_v1.20.AppImage

$ chmod +x Key-Mon-x86_64_v1.20.AppImage

$ ./Key-Mon-x86_64_v1.20.AppImage

----

original README below:

=======
Key-mon
=======
Expand Down Expand Up @@ -55,7 +104,7 @@ This program requires other libraries which you may or may not have installed.
(https://pygobject.readthedocs.io/en/latest/)
* gir1.2-gtk-3.0 - GIR bindings for the GTK3 widget set
(https://pygobject.readthedocs.io/en/latest/)

License
-------

Expand Down
4 changes: 4 additions & 0 deletions RELEASE.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
Release Notes
=============
Apr 23, 2026 (forked by setaur)
-------------------
* Added dependencies in setup.py (by setaur)
* Small README.rst modification (by setaur)

Apr 04, 2022 v 1.20
-------------------
Expand Down
Binary file added docs/keymon.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading