From 1e3f74950cc9ee6d1ed563e853662f5b4bcd7f98 Mon Sep 17 00:00:00 2001 From: cmdoret Date: Fri, 6 Sep 2024 17:27:56 +0200 Subject: [PATCH] docs(readme): minimal development instructions --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9f3dac8..14f1705 100644 --- a/README.md +++ b/README.md @@ -18,9 +18,7 @@ cargo build --release ## usage -### Command line interface - - +### command line interface To filter the top 3 matches in a file non-interactively: @@ -40,7 +38,6 @@ let matcher = TermMatcher::from_readers(vec![r1, r2]) matcher.rank_terms("some query") ``` - ### python package ```python @@ -52,3 +49,12 @@ matcher.score("query") # returns the match score of each term for the input quer matcher.rank("query") # returns the list of terms sorted by similarity with the query. matcher.top("query", 5) # shows top 5 most similar results (sorted). ``` + +## development + +A nix dev shell with all build dependencies is provided. +Assuming just and nix are installed on the machine, you can enter the shell with: + +```shell +just nix-develop +```