glenux/code-preloader
1
0
Fork 0
Code Issues 19 Pull requests Projects 1 Releases Packages Wiki Activity

doc: update README.md

Browse source
This commit is contained in:
Glenn Y. Rolland 2023-12-29 15:05:51 +01:00
parent e6ec6d9203
commit 4118caf202
1 changed files with 19 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -1,10 +1,11 @@
# Code-Preloader for ChatGPT # Code-Preloader for ChatGPT
Welcome to Code-Preloader, a tool designed to enhance the efficiency of ChatGPT Code-Preloader is a specialized tool designed to streamline the process of
by preloading all files within a specified root directory and concatenating working with ChatGPT on coding projects. It preloads and concatenates files
them into a single file. This tool is particularly useful for preparing smaller from a specified directory, allowing for the seamless integration of customized
codebases for processing by ChatGPT, as it allows for the inclusion of prompts. This tool is ideal for those who seek an alternative to tools like
customized prompts through header and footer files. GitHub Copilot, enabling a more efficient and tailored interaction with
ChatGPT.
## Features ## Features
@ -14,8 +15,9 @@ customized prompts through header and footer files.
## Limitations ## Limitations
**Note:** Code-Preloader is only suitable for smaller codebas. ChatGPT may not **Note:** Note: This tool is optimized for smaller codebases. For larger
perform as expected with large code repositories. repositories, performance may not be optimal due to processing constraints and
the nature of interactions with ChatGPT.
## Installation ## Installation
@ -48,6 +50,8 @@ Options:
### Examples ### Examples
#### Basic Use Case
To preload all files in the `src` directory and output to `result.txt`, while To preload all files in the `src` directory and output to `result.txt`, while
ignoring the `git` the `bin` directory, and the result file itself: ignoring the `git` the `bin` directory, and the result file itself:
@ -55,6 +59,8 @@ ignoring the `git` the `bin` directory, and the result file itself:
./bin/code-preloader -o result.txt -i .git -i result.txt -i bin/ src ./bin/code-preloader -o result.txt -i .git -i result.txt -i bin/ src
``` ```
#### Advanced Use Case
To preload all files in the `src` directory and output to clipboard, prepending To preload all files in the `src` directory and output to clipboard, prepending
and appending prompts, while ignoring the `git` the `bin` directory, and the and appending prompts, while ignoring the `git` the `bin` directory, and the
result file itself: result file itself:
@ -87,5 +93,10 @@ information.
## Acknowledgments ## Acknowledgments
- Special thanks to all contributors and users of this project! * A special thanks to all contributors and users of this project for their valuable feedback and support.
* Inspired by the community's need for efficient code preparation tools in the context of AI-assisted programming.
## Related projects
* [mpoon/gpt-repository-loader](https://github.com/mpoon/gpt-repository-loader)