diff --git a/lucene/luke/README.md b/lucene/luke/README.md new file mode 100644 index 00000000000..335b232db7d --- /dev/null +++ b/lucene/luke/README.md @@ -0,0 +1,39 @@ + + +# Luke + +## Introduction + +Luke (atop Swing) is the GUI tool for introspecting your Lucene index. It allows: + +* Browsing your documents, indexed terms and posting lists +* Searching in the index +* Performing index maintenance: index health checking, index optimization (take a backup before running this!) +* Testing your custom Lucene analyzer (Tokenizer/CharFilter/TokenFilter) + +![Swing Luke](luke-swing.png) + +## Launching Luke + +Using a binary release + +The [Lucene Downloads](https://lucene.apache.org/core/downloads.html) page contains stable releases of Lucene including Luke. Download the respective release, unpack and run a shell or batch scripts inside the folder 'luke' (or directly with java -jar if you prefer it that way). + +## Older releases + +Older releases of Luke (prior to 8.1) can be found at https://github.com/DmitryKey/luke diff --git a/lucene/luke/luke-swing.png b/lucene/luke/luke-swing.png new file mode 100644 index 00000000000..4aa82033c6f Binary files /dev/null and b/lucene/luke/luke-swing.png differ