Add one-click installers for Linux, Windows, and MacOS (#146)
* feat: Add installers for linux, windows, and macos * docs: Update README * pre-commit fix styles * Update installers and README * Remove env vars check and fix paths * Update installers: * Remove start.py and move install and launch part back to .sh/.bat * Add conda deactivate * Make messages more informative * Improve kotaemon based on insights from projects (#147) - Include static files in the package. - More reliable information panel. Faster & not breaking randomly. - Add directory upload. - Enable zip file to upload. - Allow setting endpoint for the OCR reader using environment variable. * feat: Add installers for linux, windows, and macos * docs: Update README * pre-commit fix styles * Update installers and README * Remove env vars check and fix paths * Update installers: * Remove start.py and move install and launch part back to .sh/.bat * Add conda deactivate * Make messages more informative * Make macOS installer runable and improve Windows, Linux installers * Minor fix macos commands * installation should pause before exit * Update Windows installer: add a new label to exit function with error * put install_dir to .gitignore * chore: Add comments to clarify the 'end' labels --------- Co-authored-by: Duc Nguyen (john) <trungduc1992@gmail.com> Co-authored-by: ian <ian@cinnamon.is>
This commit is contained in:
20
README.md
20
README.md
@@ -7,13 +7,23 @@ projects.
|
||||
|
||||
## Install
|
||||
|
||||
```shell
|
||||
pip install kotaemon@git+ssh://git@github.com/Cinnamon/kotaemon.git
|
||||
```
|
||||
### Easy install
|
||||
|
||||
## Contribute
|
||||
1. Clone the repository.
|
||||
2. Navigate to the `scripts` folder and start an installer that matches your OS:
|
||||
- Linux: `run_linux.sh`
|
||||
- Windows: `run_windows.bat`
|
||||
- macOS: `run_macos.sh`
|
||||
3. After the installation, the installer will ask to launch the ktem's UI, answer to continue.
|
||||
4. If launched, the application will be available at `http://localhost:7860/`. Let's start exploring!
|
||||
|
||||
### Setup
|
||||
Here is the setup and update strategy:
|
||||
|
||||
- **Run `run_*` script**: This setup environment, including downloading Miniconda (in case Conda is not available in your machine) and installing necessary dependencies in `install_dir` folder.
|
||||
- **Launch the UI**: To launch the ktem's UI after initial setup or any changes, simply run `run_*` script again.
|
||||
- **Reinstall dependencies**: Simply delete the `install_dir/env` folder and run `run_*` script. The script will recreate the folder with fresh dependencies.
|
||||
|
||||
### Manual install
|
||||
|
||||
- Create conda environment (suggest 3.10)
|
||||
|
||||
|
Reference in New Issue
Block a user