diff --git a/README.md b/README.md index 698a20ee4..6151b7684 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,25 @@ # raptor-rs Raptor, the new RISE + +## Usage + +First you need to generate the index files. + +```bash +$ cargo build --release --bin raptor-indexer +$ time ./target/release/raptor-indexer products.json_lines +``` + +Once the command finished indexing you will have 3 files that compose the index: +- The `xxx.map` represent the fst map. +- The `xxx.idx` represent the doc indexes matching the words in the map. +- The `xxx.sst` is a file that contains all the fields and the values asociated with it, it is passed to the internal RocksDB. + +Now you can easily use `raptor-search` or `raptor-http` with only the prefix name of the files. (e.g. relaxed-colden). + +```bash +$ cargo run --bin raptor-search -- relaxed-colden +$ cargo run --bin raptor-http -- relaxed-colden +``` + +Note: If you have performance issues run the searcher in release mode (i.e. `--release`). diff --git a/raptor-http/src/main.rs b/raptor-http/src/main.rs index ba0a136bb..059008533 100644 --- a/raptor-http/src/main.rs +++ b/raptor-http/src/main.rs @@ -81,7 +81,7 @@ where M: AsRef, } fn main() { - let name = env::args().nth(1).expect("Missing meta file name (e.g. lucid-ptolemy)"); + let name = env::args().nth(1).expect("Missing meta file name (e.g. relaxed-colden)"); let map_file = format!("{}.map", name); let idx_file = format!("{}.idx", name); let sst_file = format!("{}.sst", name); diff --git a/raptor-search/src/main.rs b/raptor-search/src/main.rs index b04cbcefb..8cd8b29ce 100644 --- a/raptor-search/src/main.rs +++ b/raptor-search/src/main.rs @@ -46,7 +46,7 @@ fn search(metadata: &Metadata, database: &DB, common_words: &CommonWords, query: } fn main() { - let name = env::args().nth(1).expect("Missing meta file name (e.g. lucid-ptolemy)"); + let name = env::args().nth(1).expect("Missing meta file name (e.g. relaxed-colden)"); let map_file = format!("{}.map", name); let idx_file = format!("{}.idx", name); let sst_file = format!("{}.sst", name);