Skip to content

Commit 29aba99

Browse files
committed
Updating readme
1 parent 1c3fb98 commit 29aba99

File tree

1 file changed

+47
-49
lines changed

1 file changed

+47
-49
lines changed

README.md

Lines changed: 47 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,10 @@ JNativeHook: Global keyboard and mouse listeners for Java.
55
![Nightly Build](https://github.com/kwhat/jnativehook/workflows/Nightly%20Build/badge.svg)
66

77
## About
8-
JNativeHook is a library to provide global keyboard and mouse listeners for
9-
Java. This will allow you to listen for global shortcuts or mouse motion that
10-
would otherwise be impossible using pure Java. To accomplish this task,
11-
JNativeHook leverages platform-dependent native code through Java's native
12-
interface to create low-level system-wide hooks and deliver those events to
13-
your application.
8+
JNativeHook is a library to provide global keyboard and mouse listeners for Java. This will allow you to listen for
9+
global shortcuts or mouse motion that would otherwise be impossible using pure Java. To accomplish this task,
10+
JNativeHook leverages platform-dependent native code through Java's native interface to create low-level system-wide
11+
hooks and deliver those events to your application.
1412

1513
The following events are available via their respective listeners.
1614
* Key Press Events
@@ -23,56 +21,56 @@ The following events are available via their respective listeners.
2321
* Mouse Drag Events
2422
* Mouse Wheel Events
2523

26-
In addition to global event listners, this library has the ability to post native events back to the native operating
24+
In addition to global event listeners, this library has the ability to post native events back to the native operating
2725
system.
2826

2927
## Licensing
30-
JNativeHook is covered under *both* the [GNU General Public](COPYING.md) *and*
31-
[GNU Lesser General Public](COPYING.LESSER.md) Licenses as the latter is an extension of the former granting you
32-
additional distribution rights. As I understand it, you may use this library in proprietary projects so long as it
33-
remains an external library with the same binary interface. You may modify the source code of this library to fulfill
34-
a proprietary need, as long as that source code is made public under the aforementioned terms. Please consult with a
35-
licenced attorney if you have licence compatibility questions or concerns.
36-
28+
JNativeHook is covered under the [GNU Lesser General Public License](COPYING.LESSER.md) which is an extension of the
29+
[GNU General Public License](COPYING.md) that grants you additional distribution rights. As I understand it, you may
30+
use this library in proprietary (closed source) projects so long as it remains an external library with the same binary
31+
interface. You may modify the source code of this library to fulfill any proprietary need, as long as those
32+
modifications are made available under the terms and conditions of the LGPL. Please consult with a licenced attorney
33+
if you have additional licence compatibility questions or concerns.
34+
3735
## Download
38-
Binary distribution for JNativeHook can be found at the
39-
[releases](https://github.com/kwhat/jnativehook/releases) section of the
40-
[project page](https://github.com/kwhat/jnativehook). Maven users can
41-
use the `<groupId>com.github.kwhat</groupId>` and `<artifactId>jnativehook</artifactId>`
42-
to include this library automatically. The nightly builds can be found at the maven
36+
Binary distribution for JNativeHook can be found at the
37+
[releases](https://github.com/kwhat/jnativehook/releases) section of the
38+
[project page](https://github.com/kwhat/jnativehook). Maven users can
39+
use the `<groupId>com.github.kwhat</groupId>` and `<artifactId>jnativehook</artifactId>`
40+
to include this library automatically. The nightly builds can be found at the maven
4341
[snapshot repository](https://oss.sonatype.org/content/repositories/snapshots/com/github/kwhat/jnativehook/2.2-SNAPSHOT).
4442

4543
## Software and Hardware Requirements
46-
* Java 1.8 - 11
44+
* Java 1.8 - 17
4745
* 256 MB of RAM
48-
* Apple OS X 10.5 - 10.12
49-
* amd64
50-
* Enable Access for Assistive Devices
46+
* Apple OS X 10.5 - 11.6
47+
* amd64, aarch64
48+
* Enable Access for Assistive Devices
5149
* Windows 2000 - 10
52-
* i586, amd64
50+
* i586, amd64, arm7
5351
* X11 Linux
54-
* i586, amd64, arm7, aarch64
55-
* libxkbfile.so.1
56-
* libxkbcommon-x11.so.0
57-
* libxkbcommon.so.0
58-
* libX11-xcb.so.1
59-
* libX11.so.6
60-
* libxcb.so.1
61-
* libXinerama.so.1
62-
* libXt.so.6
63-
* libXtst.so.6
64-
* libc.so.6
65-
* libxcb-xkb.so.1
66-
* libdl.so.2
67-
* libXau.so.6
68-
* libXdmcp.so.6
69-
* libXext.so.6
70-
* libSM.so.6
71-
* libICE.so.6
72-
* libbsd.so.0
73-
* libuuid.so.1
74-
* librt.so.1
75-
* libpthread.so.0
52+
* i586, amd64, arm7, aarch64
53+
* libxkbfile.so.1
54+
* libxkbcommon-x11.so.0
55+
* libxkbcommon.so.0
56+
* libX11-xcb.so.1
57+
* libX11.so.6
58+
* libxcb.so.1
59+
* libXinerama.so.1
60+
* libXt.so.6
61+
* libXtst.so.6
62+
* libc.so.6
63+
* libxcb-xkb.so.1
64+
* libdl.so.2
65+
* libXau.so.6
66+
* libXdmcp.so.6
67+
* libXext.so.6
68+
* libSM.so.6
69+
* libICE.so.6
70+
* libbsd.so.0
71+
* libuuid.so.1
72+
* librt.so.1
73+
* libpthread.so.0
7674

7775
## Donate
7876
If you have found this library useful, please consider making a donation.
@@ -88,10 +86,10 @@ If you have found this library useful, please consider making a donation.
8886
* [Consuming Events (Unsupported)](doc/ConsumingEvents.md)
8987

9088
## Demo Application
91-
The graphical example application exists to provide a real-time demonstration of raw output for all available native
92-
events. To run the application simply execute the jar file provided. Source code available at
89+
The graphical example application exists to provide a real-time demonstration of raw output for all available native
90+
events. To run the application simply execute the jar file provided. Source code available at
9391
[src/main/java/com/github/kwhat/jnativehook/example/NativeHookDemo.java](src/main/java/com/github/kwhat/jnativehook/example/NativeHookDemo.java).
9492

9593
## Additional Information
96-
Up to date source code and documentation available at:
94+
Up-to-date source code and documentation available at:
9795
[https://github.com/kwhat/jnativehook/](https://github.com/kwhat/jnativehook/)

0 commit comments

Comments
 (0)