doc: improve presentation
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
Glenn Y. Rolland 2024-01-03 18:18:18 +01:00
parent 29a13e28cd
commit e74a98f228

View file

@ -9,26 +9,29 @@
![License LGPL3.0-or-later](https://img.shields.io/badge/license-LGPL3.0--or--later-blue.svg) ![License LGPL3.0-or-later](https://img.shields.io/badge/license-LGPL3.0--or--later-blue.svg)
[![Donate on patreon](https://img.shields.io/badge/patreon-donate-orange.svg)](https://patreon.com/glenux) [![Donate on patreon](https://img.shields.io/badge/patreon-donate-orange.svg)](https://patreon.com/glenux)
# Code-Preloader for ChatGPT # Code-Preloader
Code-Preloader is a specialized tool designed to streamline the process of Code-Preloader is a specialized tool designed to streamline the process of
working with ChatGPT on coding projects. It preloads and concatenates files working on coding projects with interactive large language models (LLM) like
from a specified directory, allowing for the seamless integration of customized ChatGPT, Claude, Mixtral 8x7B, etc.
prompts. This tool is ideal for those who seek an alternative to tools like
GitHub Copilot, enabling a more efficient and tailored interaction with It preloads and concatenates files from a specified directory, allowing for the
ChatGPT. seamless integration of customized prompts.
This tool is ideal for those who seek an alternative to tools like GitHub
Copilot, enabling a tailored interaction with your favorite LLM.
## Features ## Features
* Preload and concatenate files from a given directory. * Preload and concatenate files from a given directory.
* Customizable header and footer prompts for ChatGPT. * Customizable header and footer prompts for your LLM.
* Simple command-line interface for easy operation. * Simple command-line interface for easy operation.
## Limitations ## Limitations
**Note:** This tool is optimized for smaller codebases. For larger **Note:** This tool is optimized for smaller codebases. For larger
repositories, performance may not be optimal due to processing constraints and repositories, performance may not be optimal due to processing constraints and
the nature of interactions with ChatGPT. the nature of interactions with LLMs.
## Prerequisites ## Prerequisites