917fb0a082
* Treat index id as auto-generated field * fix Can't create index: KeyError: 'embedding' #28 * udpate docs * Update requirement * Use lighter default local embedding model --------- Co-authored-by: ian <ian@cinnamon.is>
42 lines
1.7 KiB
Markdown
42 lines
1.7 KiB
Markdown
# Getting Started with Kotaemon
|
|
|
|
|
|
|
|
This page is intended for **end users** who want to use the `kotaemon` tool for Question
|
|
Answering on local documents. If you are a **developer** who wants contribute to the project, please visit the [development](development/index.md) page.
|
|
|
|
## Download
|
|
|
|
Download and upzip the latest version of `kotaemon` by clicking this
|
|
[link](https://github.com/Cinnamon/kotaemon/archive/refs/heads/main.zip).
|
|
|
|
## Installation
|
|
|
|
1. Navigate to the `scripts` folder and start an installer that matches your OS:
|
|
- Windows: `run_windows.bat`. Just double click the file.
|
|
- macOS: `run_macos.sh`
|
|
1. Right click on your file and select Open with and Other.
|
|
2. Enable All Applications and choose Terminal.
|
|
3. NOTE: If you always want to open that file with Terminal, then check Always Open With.
|
|
4. From now on, double click on your file and it should work.
|
|
- Linux: `run_linux.sh`. If you are using Linux, you would know how to run a bash script, right ?
|
|
2. After the installation, the installer will ask to launch the ktem's UI, answer to continue.
|
|
3. If launched, the application will be open automatically in your browser.
|
|
|
|
## Launch
|
|
|
|
To launch the app after initial setup or any changes, simply run the `run_*` script again.
|
|
|
|
A browser window will be opened and greet you with this screen:
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
For how to use the application, see [Usage](usage.md). This page will also be available to
|
|
you within the application.
|
|
|
|
## Feedback
|
|
|
|
Feel free to create a bug report or a feature request on our [repo](https://github.com/Cinnamon/kotaemon/issues).
|