[AUR-387, AUR-425] Add start-project to CLI (#29)
This commit is contained in:
@@ -0,0 +1,37 @@
|
||||
<div align="center">
|
||||
|
||||
# Project {{ cookiecutter.project_name }}
|
||||
|
||||
[](https://github.com/Cinnamon/kotaemon)
|
||||
|
||||
</div>
|
||||
|
||||
# Install
|
||||
|
||||
```bash
|
||||
# Create new conda env (optional)
|
||||
conda create -n {{ cookiecutter.project_name }} python=3.10
|
||||
conda activate {{ cookiecutter.project_name }}
|
||||
|
||||
# Clone and install the project
|
||||
git clone "<{{ cookiecutter.project_name }}-repo>"
|
||||
cd "<{{ cookiecutter.project_name }}-repo>"
|
||||
pip install -e .
|
||||
|
||||
# Generate the project structure
|
||||
cd ..
|
||||
kh start-project
|
||||
```
|
||||
|
||||
# Usage
|
||||
|
||||
- Build the pipeline in `pipeline.py`
|
||||
|
||||
For supported utilities and tools, refer: https://github.com/Cinnamon/kotaemon/wiki/Utilities
|
||||
|
||||
# Contribute
|
||||
|
||||
- For project issues and errors, please report in this repo issues.
|
||||
- For kotaemon issues and errors, please report or make PR fixes in https://github.com/Cinnamon/kotaemon.git
|
||||
- If the template for this project has issues and errors, please report or make
|
||||
PR fixes in https://github.com/Cinnamon/kotaemon/tree/main/templates/project-default
|
Reference in New Issue
Block a user