Skip to content
This repository was archived by the owner on Nov 9, 2017. It is now read-only.

Commit f02fe89

Browse files
committed
Updated readme
1 parent 1e09e95 commit f02fe89

File tree

2 files changed

+14
-9
lines changed

2 files changed

+14
-9
lines changed

Cargo.toml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ stopwatch = "0.0.6"
1515
lto = true
1616

1717
[features]
18-
default = ["server", "color"]
18+
default = ["color"]
1919
dump_data = []
20-
wait_on_exit = []
21-
server = []
2220
color = []

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,32 @@
22

33
Project from Software Pattern class.
44

5-
## Running
5+
## Running server
66

77
(Make sure you have [Rust](https://www.rust-lang.org/downloads.html) installed)
88

99
```
10-
$ cargo run --release SyllableDB-V1.dat
10+
$ cargo run --bin thaiengine --release SyllableDB-V1.dat
1111
```
1212

1313
(Syllable database can be obtained from the class Facebook group)
1414

1515
Optional features:
1616

17-
- `assertion`: Show time used to perform certain operations
1817
- `dump_data`: Print data while loading/searching
19-
- `wait_on_exit`: Don't exit, instead wait for long time
20-
- `interactive`: Interactive build: ask for file to read, ask for search queries
18+
- `color` (default): Use colored log. Disable if your platform have problem rendering it
19+
- Set `RUST_LOG=debug` to view more logs
2120

2221
To enable features:
2322

2423
```
25-
$ cargo run --features="assertion dump_data" SyllableDB-V1.dat
24+
$ cargo run --features="dump_data" --bin thaiengine --release SyllableDB-V1.dat
25+
```
26+
27+
**Note**: Running without `--release` will use another code path with assertions, resulting in slower program.
28+
29+
## Running client
30+
31+
```
32+
$ cargo run --bin client --release
2633
```

0 commit comments

Comments
 (0)