Skip to content

Commit 49b3e71

Browse files
authored
Make vx more visible in the README (#2933)
1 parent 341ffe6 commit 49b3e71

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,9 +196,26 @@ Vortex to model more complex arrays while still exposing a logical interface. Fo
196196
`ChunkedArray` where the first chunk is run-length encoded and the second chunk is dictionary encoded.
197197
In Arrow, `RunLengthArray` and `DictionaryArray` are separate incompatible types, and so cannot be combined in this way.
198198

199-
## Usage
199+
## vx - Vortex's built-in file investigation tool
200200

201-
For best performance we recommend using [MiMalloc](https://github.com/microsoft/mimalloc) as the application's
201+
Vortex has its own TUI-based tool called `vx` that can be used to investigate a file's structure. It can show a file's layout, compressions, columns statistics and chunking.
202+
We keep adding new capabilities and features to it all the time because we use it ourselves during development!
203+
204+
In order to install `vx`, you need to have `cargo` install and then you can just the following command to get the latest release
205+
206+
```bash
207+
cargo install vortex-tui --locked
208+
```
209+
210+
If you want to build it from source, you can pull this repo and run
211+
212+
```bash
213+
cargo install --path vortex-tui --locked
214+
```
215+
216+
## Performance Tips
217+
218+
For the best performance, we recommend using [MiMalloc](https://github.com/microsoft/mimalloc) as the application's
202219
allocator.
203220

204221
```rust

0 commit comments

Comments
 (0)