Skip to content

Commit

Permalink
add a new section to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
amtoine committed May 26, 2024
1 parent 39e94b5 commit 19e47ae
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ A fast *interactive explorer* tool for *structured data* inspired by [`nu-explor
- [*an example*](#an-example)
- [*some convenience*](#-some-convenience)
- [*see the documentation locally*](#see-the-documentation-locally)
- [*troubleshooting*](#troubleshooting)
- [*contributing*](#contributing)
- [*TODO*](#todo)
- [*features*](#features)
Expand Down Expand Up @@ -110,6 +111,20 @@ and voila :yum:
cargo doc --document-private-items --no-deps --open
```

# troubleshooting
in case you get some weird error or behaviour, before filing any issue, the
easiest is to make sure the plugin is compiled with the same revision as the
Nushell you are using!
```nushell
use scripts/deps.nu; deps --current
```
and then you can come back to the [*installation*](#installation) section.

> **Note**
> of course, this will not work if the version of Nushell you are using is too
> old, because then the state of `nu_plugin_explore` will be too recent for
> everything to compile properly...
# contributing
in order to help, you can have a look at
- the [todo](#todo) list down below, there might be unticked tasks to tackle
Expand Down

0 comments on commit 19e47ae

Please sign in to comment.