From b8c4886832c0c503836132cc36022984f2936524 Mon Sep 17 00:00:00 2001 From: Raghu Rajagopalan Date: Thu, 27 Sep 2018 15:27:10 +0530 Subject: [PATCH] add readme --- README.adoc | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 README.adoc diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..5f4b418 --- /dev/null +++ b/README.adoc @@ -0,0 +1,37 @@ +# Freaky fast fuzzy finder (Denite matcher) + +This is a denite.nvim matcher. + +## Installation + +`Plug 'raghur/fruzzy'` + +## Configuration + +`let fruzzy#usenative = 1` + +## Native modules + +Native module gives a 10 - 15x speedup over python - ~40-60μs! + +. Download and copy to `rplugin/python3` +. Prebuilt windows and linux modules coming soon + + +## Development + +.Running tests +. Clone +. cd `rplugin/python3` +. `pytest` - run tests with python implementation +. `FUZZY_CMOD=1 pytest` - run tests with native module + +.Build native module +. install nim devel (0.18 and 0.18.1 will not work) +. [Windows] `nim c --app:lib --out:fruzzy_mod.pyd -d:release -d:removelogger fruzzy_mod` +. [Linux] `nim c --app:lib --out:fruzzy_mod.so -d:release -d:removelogger fruzzy_mod` +. `-d:removelogger` + - removes all log statements from code. + - Without this symbol defined, you will get info level logging. + - If you remove `-d:release` you will also get debug level logging +