From 7fe82523b6fbd3eb9b72054e0186456ce6cdffb9 Mon Sep 17 00:00:00 2001 From: Hayden Johnson Date: Sun, 28 Jul 2024 18:34:31 -0700 Subject: [PATCH] Add README.md --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e765673 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# Project Title + +This project contains two Bash scripts used to generate context files for prompting LLM's with repo-wide context. + +## Scripts + +### `naive-prompt.sh` + +This script lists all files in the git repository, excluding `.gitignore` and `LICENSE` files. It prints each file's name followed by its contents, formatted as Markdown code blocks. The output provides a comprehensive list of files and their contents, suitable for use as as prepended context as a prompt to an llm to ask questions about a repo. + +**NOTE** this puts the entire repository in context, so make sure the LLM you feed it into has enough of a context window to support it. That is the purpose of the script below. + +### `repo-size.sh` + +This script provides statistics about the size of the git repository, excluding `.gitignore` and `LICENSE` files. It calculates the number of words, bytes, and estimated tokens (based on dividing the word count by 4) in the repository. +