Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
octobanana committed Jan 11, 2019
1 parent 2fd39e4 commit 1593081
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,38 @@ A colourful binary clock for the terminal.
## About
Peaclock is a customizable binary clock made for the terminal.

Each column represents a single digit.
The first two columns are the two hour digits,
the next two are the minute digits,
and the last two are the seconds digits.

The bottom row is the low-order bit,
which makes it worth a value of 1.
The next row up is worth 2, then 4, followed by 8.
Adding up the __on__ bits gives the value of the digit.

```
| | | < 8
| || || < 4
|| || || < 2
|| || || < 1
HH:MM:SS
```

### Features
* digital clock
* binary clock
* 12/24 hour time
* customize with hex colour codes
* set a custom character for the binary clock graphic
* set a custom unicode character for the binary clock graphic
* compact or expanded mode
* toggle visibility of digital and binary clocks
* command prompt with a readline-like interface

## Usage
View the usage and help output with the `--help` or `-h` flag.
The help output also contains the documentation for the key bindings and commands for customization.

## Build
### Environment
* Linux (supported)
Expand Down

0 comments on commit 1593081

Please sign in to comment.