Skip to content

Commit 7a247b8

Browse files
committed
Polish README
1 parent 531ff9e commit 7a247b8

1 file changed

Lines changed: 25 additions & 22 deletions

File tree

README.md

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,46 @@
1-
| :exclamation: Work in progress |
2-
|--------------------------------|
1+
# `headjack` - Interactive NIfTI Viewer for the Terminal
32

4-
# `headjack`
3+
`headjack` is a versatile NIfTI image viewer tailored for the terminal. It offers seamless compatibility with most platforms, including remote clusters and containerized environments, making it an ideal choice for researchers and developers.
54

6-
NIfTI viewer for the terminal.
7-
8-
(Placeholder screenshot)
95
![Screenshot](doc/demo.png)
106

117
## Usage
128

9+
To view NIfTI images in the terminal, simply run:
10+
1311
```sh
1412
headjack image.nii.gz
1513
```
1614

1715
### Controls
1816

17+
Use the following controls to navigate and interact with the viewer:
18+
1919
| Key | Action |
2020
| --- | --- |
21-
| <kbd>&uarr;</kbd> <kbd>&darr;</kbd> or <kbd>A</kbd> <kbd>D</kbd> | Navigate X axis / Metadata scrolling |
22-
| <kbd>&larr;</kbd> <kbd>&rarr;</kbd> or <kbd>W</kbd> <kbd>S</kbd> | Navigate Y axis / Metadata scrolling |
23-
| <kbd>Z</kbd> <kbd>X</kbd> or <kbd>Y</kbd> <kbd>X</kbd> | Navigate Z axis |
24-
| <kbd>tab</kbd> | Toggle metadata view |
25-
| <kbd>c</kbd> | Toggle color map |
26-
| <kbd>Q</kbd> or <kbd>esc</kbd> or <kbd>ctrl</kbd> + <kbd>C</kbd> | Quit |
21+
| <kbd>&uarr;</kbd> <kbd>&darr;</kbd> or <kbd>A</kbd> <kbd>D</kbd> | Navigate along the X-axis / Scroll through metadata |
22+
| <kbd>&larr;</kbd> <kbd>&rarr;</kbd> or <kbd>W</kbd> <kbd>S</kbd> | Navigate along the Y-axis / Scroll through metadata |
23+
| <kbd>Z</kbd> <kbd>X</kbd> or <kbd>Y</kbd> <kbd>X</kbd> | Navigate along the Z-axis |
24+
| <kbd>Tab</kbd> | Toggle metadata view |
25+
| <kbd>C</kbd> | Toggle color map |
26+
| <kbd>Q</kbd> or <kbd>Esc</kbd> or <kbd>Ctrl</kbd> + <kbd>C</kbd> | Quit |
2727

2828
## Installation
2929

30-
### Precompiled binaries (recommended)
30+
### Precompiled Binaries (Recommended)
3131

32-
Head over to [releases](https://github.com/cmi-dair/headjack/releases) and download the latest binary for your platform.
32+
We recommend downloading the latest precompiled binary for your platform from the [releases](https://github.com/cmi-dair/headjack/releases) page. Optionally, you can add the binary to your `PATH` environment variable for easier access. `headjack` is a self-contained executable with no runtime dependencies.
3333

34-
**Optionally** add the binary to your `PATH` environment variable.
34+
To simplify access, consider aliasing the binary to `hj`:
35+
36+
```sh
37+
alias hj=/path/to/headjack
38+
```
3539

36-
`headjack` is and will always be a single executable with 0 runtime dependencies.
3740

3841
### Build from source
3942

40-
With latest Rust compiler installed, run:
43+
If you prefer to build `headjack` from source, ensure you have the latest Rust compiler installed and then run:
4144

4245
```sh
4346
cargo build --release
@@ -47,16 +50,16 @@ The binary will be located at `target/release/headjack`.
4750

4851
## Troubleshooting
4952

50-
### Terminal colors look weird
53+
### Terminal Colors Issue
5154

52-
Your terminal might not support 24-bit colors. Try running `headjack` with `-a`/`--ansi` for 256 ANSI color mode or `-b`/`--bw` for black and white mode.
55+
If your terminal displays colors incorrectly, it may not support 24-bit colors. You can try running headjack with the `-a`/`--ansi` flag for 256 ANSI color mode.
5356

54-
### Unix: libc error on startup
57+
### Unix: Libc Error on Startup
5558

56-
If you get an error like this:
59+
If you encounter an error related to `libc` when starting headjack, such as:
5760

5861
```
5962
/lib64/libm.so.6: versionGLIBC_2.29' not found
6063
```
6164

62-
You are probably using an older version of glibc. Try using the `*-musl` variant from the [releases page](https://github.com/cmi-dair/headjack/releases). Or build from source with `musl` target.
65+
It likely indicates that you are using an older version of glibc. Consider using the `*-musl` variant available on the [releases page](https://github.com/cmi-dair/headjack/releases), or build `headjack` from source with the `musl` target.

0 commit comments

Comments
 (0)