Skip to content

Commit

Permalink
Merge branch 'master' of github.com:bostrt/quikey
Browse files Browse the repository at this point in the history
  • Loading branch information
bostrt committed Nov 29, 2020
2 parents 17a3a29 + ac5547a commit cd6a730
Showing 1 changed file with 29 additions and 14 deletions.
43 changes: 29 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,26 @@ A keyboard macro tool.
* [Managing phrase entries](#managing-phrase-entries)


# Installation
# Installation and Upgrade


The following packages will install two commands:

- `qk`
- `quikey-daemon`

Everything can be managed using just `qk` and examples are [further below](#usage).


## Python 3
```shell
$ pip3 install --user quikey
$ pip3 install --user quikey
$ pip3 install --user -U quikey #<-- Upgrade
```
or
```shell
$ python3 -m pip install --user quikey
$ python3 -m pip install --user -U quikey #<-- Upgrade
```

## Arch Linux (AUR)
Expand All @@ -34,33 +45,29 @@ $ curl -L -O https://aur.archlinux.org/cgit/aur.git/snapshot/quikey.tar.gz && ta
```shell
$ dnf copr enable bostrt/quikey # Enable repo
$ dnf install quikey # Install pkg
$ dnf update quikey # Update pkg
```

## Ubuntu, Debian, MXLinux, Mint, etc (PPA)
```shell
coming soon
```

The packages above install two executables:
- `qk`
- `quikey-daemon`

Everything can be managed using just `qk` and examples are below.

# Usage

## Quickstart



## Managing the daemon
There is a daemon process that must be running for Quikey's macro functionality to run. You can manage the daemon from the `qk` client:

#### Start daemon
### Start daemon
```shell
$ qk start
```

### Autostart on Login
```shell
$ qk autostart enable
```

### Stop daemon
```shell
$ qk stop
Expand All @@ -84,6 +91,14 @@ $ qk ls
+---------+------+----------------------------+-----------------------------+

```

### Interactive editing
Use interactive menus to edit and remove phrases:
```
$ qk edit
$ qk rm
```

### Editing a phrase
```shell
$ qk edit -n ':hello:'
Expand All @@ -98,4 +113,4 @@ quikey phrase with key of :hello: has been deleted.

## Development

See [DEVELOP.md](DEVELOP.md) for help.
See [DEVELOP.md](DEVELOP.md) for help.

0 comments on commit cd6a730

Please sign in to comment.