Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix #248, format README #249

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
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
23 changes: 0 additions & 23 deletions README

This file was deleted.

41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# xdotool
Simulate input from the mouse and keyboard very easily.
Also supports window manager actions such as moving, activating, and other actions on windows.
## libxdo
C library for doing the same.

## Documentation
See the [website](http://www.semicomplete.com/projects/xdotool/) or manpage (see below) for more up-to-date documentation.

## Installation
xdotool is included in many package managers

|Operating System|command|
|------|-------|
|Arch Linux |`pacman -S xdotool`|
|Debian/Ubuntu|`apt-get install xdotool`|
|FreeBSD|`pkg install xdotool`|
|Fedora|`dnf install xdotool`|
|macOS|`brew install xdotool`|
|OpenSUSE|`zypper install xdotool`|

## Compilation

Compile: `make`

Run tests: `make test` (requires ruby, Xvfb)

Install: `make install`

Remove: `make uninstall`

You may have to set `PREFIX` to the location you want to install to.
The default `PREFIX` is `/usr/local`

For packagers, there's also support for DESTDIR for staged install.

Also, see the manpage, which you can generate by running `make showman`
Note: the manpage will be installed during `make install`

## Questions
See the [FAQ](FAQ.md)