ubaldus commited on
Commit
01c9291
·
verified ·
1 Parent(s): 5e6ea98

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +21 -19
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 this Dataset
41
 
42
- 1. **Download the Desired Database:** Choose the database for the language you want to use and download the corresponding `.db.gz` file.
 
43
 
44
- 2. **Decompress the Database:** Use a tool like `gunzip` to decompress the downloaded file. For example, on Linux or macOS, you can run the following command in your terminal:
 
45
 
46
- ```bash
47
- gunzip it.db.gz
48
- ```
49
- This will create the decompressed database file (`it.db` in the example above).
50
 
51
- 3. **Install Wikilite**: Follow the instructions on the [Wikilite github repo](https://github.com/eja/wikilite) to clone the repository and build the binary, or download a precompiled binary for your OS from [Wikilite Releases](https://github.com/eja/wikilite/releases/latest).
52
 
53
- 4. **Run Wikilite:** Navigate to the directory where you extracted the database and where you have the compiled `wikilite` binary. Use the `wikilite` command with the appropriate options. For example, to start the web interface for the Italian database, use:
 
54
 
55
- ```bash
56
- ./wikilite --db it.db --web
57
- ```
 
58
 
59
- This will start a local web server allowing you to browse and search the Wikipedia content.
 
 
 
60
 
61
- **Command-line Usage:** Alternatively, you can search the database directly from the command line:
 
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