diff --git a/irmin-pack-tools.opam b/irmin-pack-tools.opam index 6b5ae8bc04..31d1a332e8 100644 --- a/irmin-pack-tools.opam +++ b/irmin-pack-tools.opam @@ -25,7 +25,6 @@ depends: [ "cmdliner" {>= "1.1.0"} "cmdliner" {>= "1.1.0"} "notty" {>= "0.2.3"} - "prettree" "ppx_repr" {>= "0.7.0"} "ptime" "hex" @@ -33,10 +32,6 @@ depends: [ "alcotest" {with-test} ] -pin-depends: [ - ["prettree.dev" "git+https://github.com/art-w/prettree.git#568de08442f02dd87acc84ca6a91cc661b7e77bf"] -] - synopsis: "Utils for Irmin-pack" description: """ `Irmin-pack-tools` defines useful binaries and libraries for diff --git a/src/irmin-pack-tools/README.md b/src/irmin-pack-tools/README.md index a13bb6b434..a90b2e6973 100644 --- a/src/irmin-pack-tools/README.md +++ b/src/irmin-pack-tools/README.md @@ -5,7 +5,7 @@ Currently, there are the following tools: - [`ppcf`](#ppcf), a json printer for control files - [`ppidx`](#ppidx), a json printer for index folders - [`tezos-explorer`](#tezos-explorer), a notty ui for a fast exploration of tezos stores -- [`tezos-explorer-gyu`](#tezos-explorer-gui), a graphical ui for a fast exploration of tezos stores +- [`tezos-explorer-gui`](#tezos-explorer-gui), a graphical ui for a fast exploration of tezos stores ## ppcf This tool prints a control file in a human readable manner (json), allowing to fetch important informations easily. @@ -104,8 +104,9 @@ $ jq -s 'sort_by(.off)' -- index TODO ## tezos-explorer-gui -This tool is a graphical UI, meant to allow the user to figure out rapidly the shape of a commit, giving him informations on it's content. +This tool is a graphical UI, meant to allow the user to figure out rapidly the shape of a commit, giving them informations on its content. In order to launch it, uncomment the `dune` file under the path `src/irmin-pack-tools/tezos_explorer_gui` and install the deps `tsdl` and `tsdl-ttf`. +You will also need to pin the package `prettree` with `git+https://github.com/art-w/prettree.git#568de08442f02dd87acc84ca6a91cc661b7e77bf`. It can be launched using the following command: ```shell $ dune exec -- irmin-tezos-explorer-gui @@ -115,7 +116,7 @@ The first argument is the path to the root of the store (e.g. `output/root/`). The second argument is the path to a `.ttf` file, necessary to know which font to use when printing strings. -The third argument is an int, the `nth` commit stored in the index of the store that will be showned first. +The third argument is an int, the `nth` commit stored in the index of the store that will be shown first. Once the program is launched, you can: - Navigate through the indexed commits using the left and right arrows.