aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: fb51deb20f57f4348d7e4f830791a7197357383d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# Index Search

A project to index all files in a subdirectory to make
their contents searchable in a fast manner.

The following filetypes are currently supported:
- Raw Text File              (.txt)
- Word                       (.docx)
- PowerPoint                 (.pptx)
- Excel                      (.xlsx)
- Open Document Text         (.odt)
- Open Document Presentation (.odp)
- PDF                        (.pdf)

## Building from Souce

Just clone the repository and build it with `cargo`:

```sh
$ git clone https://git.nathanreiner.xyz/indexsearch
$ cd indexsearch
$ cargo build --release
```

The binary can be found under `./target/release/indexsearch`

## How to Index A directory

To generate a use the `-g` flag:

```sh
$ indexsearch -g index.idxs /path/to/directory
```

## Using the Index

```sh
$ indexsearch -s index.idxs word1 word2 ...
```