654501e01c
* move flowsettings.py and launch.py to root * update docs * sync sub package versions * rename launch.py to app.py and make run scripts work with installation package * add update scripts * auto version for root package * rename authors and update doc dir * Update auto-bump-and-release.yaml to trigger on push to main branch * latest as branch instead of tag * pin deps versions * cache the changelogs
42 lines
1.8 KiB
Markdown
42 lines
1.8 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`. Please run the script using `bash run_linux.sh` in your terminal.
|
|
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 change, simply run the `run_*` script again.
|
|
|
|
A browser window will be opened and greets 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).
|