Skip to content

Fix typos in Quick Start doc #225

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
blueviggen wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix typos in Quick Start doc #225

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/GettingStart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
### **Index Build**
```bash
Usage:
./IndexBuiler [options]
./indexbuiler [options]
Options:
-d, --dimension <value> Dimension of vector, required.
-v, --vectortype <value> Input vector data type (e.g. Float, Int8, Int16), required.
Expand All @@ -19,7 +19,7 @@
### **Index Search**
```bash
Usage:
./IndexSearcher <index folder> [options]
./indexsearcher <index folder> [options]
Options
Index.QueryFile=XXX Input Query file
Index.ResultFile=XXX Output result file
Expand Down Expand Up @@ -48,7 +48,7 @@ where each line represents the K nearest neighbors of a query separated by a bla
### **Server**
```bash
Usage:
./Server [options]
./server [options]
Options:
-m, --mode <value> Service mode, interactive or socket.
-c, --config <value> Configure file of the index
Expand All @@ -75,7 +75,7 @@ IndexFolder=BKT_gist
### **Client**
```bash
Usage:
./Client [options]
./client [options]
Options:
-s, --server Server address
-p, --port Server port
Expand All @@ -87,7 +87,7 @@ Options:
### **Aggregator**
```bash
Usage:
./Aggregator
./aggregator

Write Aggregator.ini as follows:

Expand Down