Update README.md
Browse files
README.md
CHANGED
@@ -37,34 +37,36 @@ Each language is stored as a separate compressed file (`.db.gz`) within the data
|
|
37 |
* `sc.all-mini.db.gz` - Sardinian Wikipedia database (lexical and semantic)
|
38 |
|
39 |
|
40 |
-
## How to Use
|
41 |
|
42 |
-
1.
|
|
|
43 |
|
44 |
-
2.
|
|
|
45 |
|
46 |
-
|
47 |
-
|
48 |
-
|
49 |
-
This will create the decompressed database file (`it.db` in the example above).
|
50 |
|
51 |
-
|
52 |
|
53 |
-
|
|
|
54 |
|
55 |
-
|
56 |
-
|
57 |
-
|
|
|
58 |
|
59 |
-
|
|
|
|
|
|
|
60 |
|
61 |
-
|
|
|
62 |
|
63 |
-
```bash
|
64 |
-
./wikilite --db it.db --cli
|
65 |
-
```
|
66 |
-
|
67 |
-
5. **Access the Web Interface:** If you started the web server, open a web browser and navigate to `http://localhost:35248` to access the web interface.
|
68 |
|
69 |
## About Wikilite
|
70 |
|
|
|
37 |
* `sc.all-mini.db.gz` - Sardinian Wikipedia database (lexical and semantic)
|
38 |
|
39 |
|
40 |
+
## How to Use This Dataset
|
41 |
|
42 |
+
1. **Install Wikilite**
|
43 |
+
Download a precompiled binary for your operating system from the [Wikilite Releases](https://github.com/eja/wikilite/releases/latest) page. Once downloaded, uncompress the binary.
|
44 |
|
45 |
+
2. **Run the `--setup` Command**
|
46 |
+
Execute the binary with the `--setup` option to install a pre-built database. This command will display a list of available databases, allowing you to select and download the one you need, along with the corresponding GGUF model. For example:
|
47 |
|
48 |
+
```bash
|
49 |
+
./wikilite --setup
|
50 |
+
```
|
|
|
51 |
|
52 |
+
Note: Databases in the "fts" folder are for full-text search only and do not support semantic search.
|
53 |
|
54 |
+
3. **Run Wikilite with the Installed Database**
|
55 |
+
After completing the setup, navigate to the directory containing the `wikilite` binary. Use the following commands to run Wikilite:
|
56 |
|
57 |
+
- **To start the web interface** for browsing and searching:
|
58 |
+
```bash
|
59 |
+
./wikilite --web
|
60 |
+
```
|
61 |
|
62 |
+
- **To search via the command line**:
|
63 |
+
```bash
|
64 |
+
./wikilite --cli
|
65 |
+
```
|
66 |
|
67 |
+
4. **Access the Web Interface**
|
68 |
+
If you started the web server using the `--web` option, open your browser and go to `http://localhost:35248` to access the web interface for browsing and searching the Wikipedia content.
|
69 |
|
|
|
|
|
|
|
|
|
|
|
70 |
|
71 |
## About Wikilite
|
72 |
|