Skip to content

Commit eb05115

Browse files
authored
Overhaul to readme instructions (#18)
1 parent d18ba45 commit eb05115

File tree

2 files changed

+85
-0
lines changed

2 files changed

+85
-0
lines changed

Makefile

+10
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,16 @@ else
1515
goimports -l -w .
1616
endif
1717

18+
#### Linting ####
19+
20+
# Build binary.
21+
.PHONY: build
22+
build:
23+
@mkdir -p dist
24+
go build -ldflags='-s -w' -o dist/qlock main.go
25+
@echo 'Binary build! Run it like so:'
26+
@echo ' $$ ./dist/qlock'
27+
1828
#### Release ####
1929

2030
# Build and publish binaries as Github release artifacts.

README.md

+75
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,91 @@
1+
[![Actions][github-actions-badge]][github-actions-link]
12
[![License][license-badge]][license-link]
23
[![Go Report Card][go-report-badge]][go-report-link]
4+
[![Releases][github-release-badge]][github-release-link]
35

46
# Qlock
57

68
A minimal, curses-based clock, for your terminal. Inspired by the [QlockTwo by Biegert&Funk](https://qlocktwo.com/us/ "QlockTwo by Biegert&Funk").
79

810
![qlock screenshot](images/screenshot.jpg "qlock screenshot")
911

12+
## Installing
13+
14+
### Release binary
15+
16+
Prebuilt binaries can be found on the [releases page][github-release-link]. Download the archive for your computer's architecture, extract the binary, and put it inside your `$PATH`.
17+
18+
```bash
19+
$ wget -q https://github.com/joshdk/tty-qlock/releases/download/v1.0.0/qlock-linux-amd64.tar.gz
20+
$ tar -xf qlock-linux-amd64.tar.gz
21+
$ sudo install qlock /usr/bin/qlock
22+
```
23+
24+
You can then launch qlock by running:
25+
26+
```
27+
$ qlock -help
28+
```
29+
30+
### From source
31+
32+
Alternatively, you can build it yourself by cloning the repo, and then running:
33+
34+
```bash
35+
$ make build
36+
```
37+
38+
You can then launch qlock by running:
39+
40+
```
41+
$ ./dist/qlock -help
42+
```
43+
44+
## Usage
45+
46+
### Help!
47+
48+
You can pass the `-help` flag to display the help text:
49+
50+
```
51+
$ qlock -help
52+
Usage of qlock:
53+
-off-color string
54+
color for disabled letters (default "black")
55+
-on-color string
56+
color for enabled letters (default "blue")
57+
-version
58+
print version and exit
59+
```
60+
61+
### Colors
62+
63+
You can pass the `-on-color` and `-off-color` flags to control the color of the enabled and disabled UI elements respectively.
64+
65+
Both flags can take any of the 8 standard color names (`black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, or `white`).
66+
67+
Additionally, a `+bold` suffix can be added to use the bold color variant (like `-color-on green+bold`).
68+
69+
## Bug Reporting
70+
71+
If you encounter an issue, [please report it](https://github.com/joshdk/tty-qlock/issues/new)!
72+
73+
When reporting, please include:
74+
75+
- A screenshot of your terminal (drag an image into the issue description box to attach it).
76+
- Any interaction workflow details (resizing/dragging/clicking/etc).
77+
- Your system's architecture (like `linux`/`amd64`).
78+
79+
Thank you!
80+
1081
## License
1182

1283
This code is distributed under the [BSD 3-Clause License][license-link], see [LICENSE.txt][license-file] for more information.
1384

85+
[github-actions-badge]: https://github.com/joshdk/tty-qlock/workflows/Build/badge.svg
86+
[github-actions-link]: https://github.com/joshdk/tty-qlock/actions
87+
[github-release-badge]: https://img.shields.io/github/release/joshdk/tty-qlock/all.svg
88+
[github-release-link]: https://github.com/joshdk/tty-qlock/releases
1489
[go-report-badge]: https://goreportcard.com/badge/github.com/joshdk/tty-qlock
1590
[go-report-link]: https://goreportcard.com/report/github.com/joshdk/tty-qlock
1691
[license-badge]: https://img.shields.io/badge/license-BSD-green.svg

0 commit comments

Comments
 (0)