mirror of
https://github.com/PR0M3TH3AN/RePrompt.git
synced 2025-09-07 14:38:43 +00:00
update
This commit is contained in:
27
README.md
27
README.md
@@ -44,13 +44,30 @@ git clone https://github.com/PR0M3TH3AN/RePrompt
|
||||
cd RePrompt
|
||||
```
|
||||
|
||||
### 2. Create Required Directories and Files
|
||||
Here's the updated section:
|
||||
|
||||
````markdown
|
||||
### 2. Context Files (Optional)
|
||||
|
||||
The tool looks for these files to provide additional context to AI assistants. While not required for basic functionality, they enhance the AI's understanding of your project:
|
||||
|
||||
```bash
|
||||
mkdir -p src/static_files src/global_files
|
||||
touch src/static_files/overview.txt
|
||||
touch src/static_files/important_info.txt
|
||||
touch src/static_files/to-do_list.txt
|
||||
src/static_files/
|
||||
├── overview.txt # General project description and purpose
|
||||
├── important_info.txt # Critical information AI should know
|
||||
└── to-do_list.txt # Current project tasks and goals
|
||||
```
|
||||
````
|
||||
|
||||
These files are read when generating the context file. If they don't exist, the tool will still work but those sections will be empty in the generated context. Update these files with relevant information about your project to improve AI assistance.
|
||||
|
||||
Example `overview.txt`:
|
||||
|
||||
```txt
|
||||
# Project Overview
|
||||
|
||||
This project is designed to [describe main purpose]. It [explain key functionality]
|
||||
and helps users to [describe main benefits].
|
||||
```
|
||||
|
||||
### 3. Set Up Virtual Environment
|
||||
|
@@ -1,3 +0,0 @@
|
||||
# Project Overview
|
||||
|
||||
This project is designed to generate a comprehensive context file for AI coding assistants. It aggregates essential information from your repository, enabling more informed and efficient interactions with AI tools.
|
||||
|
Reference in New Issue
Block a user