Skip to content

Commit

Permalink
Removed duplication between README.md and docs/index.rst by migrating…
Browse files Browse the repository at this point in the history
… README.md to README.rst and including it in index.rst. GitHub rst supported as limitation that forced removal of the literalinclude directive.
  • Loading branch information
blep committed Sep 7, 2023
1 parent 1a4a76a commit 0bfe756
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ existing Python modules to interact with either the window or the process.
log_focused_window script
=========================

``main.py`` shows how to use the API to produce the example output below. After
``win32_window_monitor/main.py`` shows how to use the API to produce the example output below. After
installing the ``win32-window-monitor`` package, the script ``log_focused_window`` is installed (in
``venv\Scripts\log_focused_window.exe``, which is added to the ``PATH`` when activating the venv).

Expand Down Expand Up @@ -76,11 +76,12 @@ Usage example

.. note::
To track the current foreground window, you need at least ``HookEvent.SYSTEM_FOREGROUND``
and ``HookEvent.SYSTEM_MINIMIZEEND``. (``HookEvent.SYSTEM_FOREGROUND`` is not sent when
and ``HookEvent.SYSTEM_MINIMIZEEND`` (``HookEvent.SYSTEM_FOREGROUND`` is not sent when
restoring a minimized window).


.. code-block:: python
# win32_window_monitor/main_usage_example.py
from win32_window_monitor import *
from ctypes import wintypes
Expand Down

0 comments on commit 0bfe756

Please sign in to comment.