README.rst
1=======
2AutoKey
3=======
4
5.. image:: https://img.shields.io/badge/IRC-%23autokey%20on%20freenode-blue.svg
6 :target: https://webchat.freenode.net/?channels=autokey
7
8.. image:: https://badges.gitter.im/autokey/autokey.svg
9 :alt: Join the chat at https://gitter.im/autokey/autokey
10 :target: https://gitter.im/autokey/autokey
11
12.. image:: http://img.shields.io/badge/stackoverflow-autokey-blue.svg
13 :alt: Ask and answer questions on StackOverflow
14 :target: https://stackoverflow.com/questions/tagged/autokey
15
16
17
18.. contents::
19
20
21About
22=====
23`AutoKey`_, a desktop automation utility for Linux and X11, formerly hosted at `OldAutoKey`_. Updated to run on Python 3.
24
25**Important**: This is an X11 application, and as such will not function 100% on distributions that default to using Wayland instead of Xorg.
26
27.. _AutoKey: https://github.com/autokey/autokey
28.. _OldAutoKey: https://code.google.com/archive/p/autokey/
29
30Installation
31============
32
33**Please remove previous installations of both AutoKey and AutoKey-py3 fully before installing!**
34
35For detailed installation instructions, please visit the `Installation`_ page. in our wiki.
36
37.. _Installation: https://github.com/autokey/autokey/wiki/Installing
38
39Zero-installation Method
40++++++++++++++++++++++++
41
42AutoKey can also be used directly from the cloned repository. This is useful, e.g., for trying
43out a new version without removing a current installation.
44
451. Start the Autokey daemon
46
47.. code:: sh
48
49 cd lib
50 python3 -m autokey.gtkui
51 # or for KDE
52 python3 -m autokey.qtui
53
542. Start the Autokey UI (if desired) by appending the --configure or -c command line switch to the end of the command.
55
56The commands accept CLI switches just like the regular installation, so
57:code:`python3 -m autokey.qtui -lc` works as expected.
58
59
60Documentation
61=============
62Documentation for `new features`_. For older features, please refer to the original AutoKey's `scripting API`_, `wiki`_, and `Stack Overflow`_.
63
64Examples of AutoKey scripts can be found by `searching GitHub`_ and reading AutoKey's `wiki`_.
65
66.. _scripting API: https://autokey.github.io/index.html
67.. _searching GitHub: https://github.com/search?l=Python&q=autokey&ref=cmdform&type=Repositories
68.. _wiki: https://github.com/autokey/autokey/wiki
69.. _Stack Overflow: https://stackoverflow.com/questions/tagged/autokey
70.. _new features: https://github.com/autokey/autokey/blob/master/new_features.rst
71
72Support
73=======
74
75Please do not request support on the issue tracker. Instead, head over to the autokey-users `Google Groups`_ forum, `StackOverflow`_, on `IRC`_ (#autokey on Freenode), or `Gitter`_ web-based chat.
76
77We'd appreciate it if you take a look at `Problem reporting guide`_ before posting. By providing as much information as you can, you'll have a much better chance of getting a good answer in less time.
78
79.. _Google Groups: https://groups.google.com/forum/#!forum/autokey-users
80.. _StackOverflow: https://stackoverflow.com/questions/tagged/autokey
81.. _IRC: irc://irc.freenode.net/#autokey
82.. _Gitter: https://gitter.im/autokey/autokey
83.. _Problem reporting guide: https://github.com/autokey/autokey/wiki/Problem-Reporting-Guide
84
85Bug reports and Pull Requests
86=============================
87Bug reports and PRs are welcome. Please use the `GitHub Issue Tracker`_ for bug reports. When reporting a suspected bug, please test against latest ``git HEAD`` and make sure to include as much information as possible to expedite troubleshooting and resolution. For example,
88
89* **required:** How to reproduce the issue you are experiencing
90* Python tracebacks, if any
91* Verbose logging information obtained by starting the frontend (``autokey-gtk`` or ``autokey-qt``) from terminal with the ``--verbose`` option.
92
93.. _GitHub Issue Tracker: https://github.com/autokey/autokey/issues
94
95Changelog
96=========
97Here__.
98
99__ https://github.com/autokey/autokey/blob/master/CHANGELOG.rst
100
101License
102=======
103`GNU GPL v3.`_ See the LICENSE file alongside this README for a plain text copy of the license text.
104
105.. _GNU GPL v3.: https://www.gnu.org/licenses/gpl.html
106
