diff --git a/README.md b/README.md index 9a0d43b..b7e124f 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ developers in mind. https://github.com/Cinnamon/kotaemon/assets/25688648/815ecf68-3a02-4914-a0dd-3f8ec7e75cd9 [Source Code](https://github.com/Cinnamon/kotaemon) | -[Live Demo](https://huggingface.co/spaces/lone17/kotaemon-app) +[Live Demo](https://huggingface.co/spaces/cin-model/kotaemon-public) [User Guide](https://cinnamon.github.io/kotaemon/) | [Developer Guide](https://cinnamon.github.io/kotaemon/development/) | @@ -68,6 +68,28 @@ source kotaemon-env/bin/activate pip install git+https://github.com/Cinnamon/kotaemon.git ``` +### For Contributors + +```shell +# Clone the repo +git clone git@github.com:Cinnamon/kotaemon.git + +# Create a environment +python -m venv kotaemon-env + +# Activate the environment +source kotaemon-env/bin/activate +cd kotaemon + +# Install the package in editable mode +pip install -e "libs/kotaemon[all]" +pip install -e "libs/ktem" +pip install -e "." + +# Setup pre-commit +pre-commit install +``` + ## Creating your application In order to create your own application, you need to prepare these files: diff --git a/mkdocs.yml b/mkdocs.yml index 5d33e8b..b068be8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -27,7 +27,9 @@ nav: - Contributing: development/contributing.md # generated using gen-files + literate-nav - API Reference: reference/ - - Issue Tracker: "https://github.com/Cinnamon/kotaemon/issues" + - Changelogs: https://github.com/Cinnamon/kotaemon/releases + - Issue Tracker: https://github.com/Cinnamon/kotaemon/issues + - Live Demo: https://huggingface.co/spaces/cin-model/kotaemon-public markdown_extensions: - admonition