Skip to content

Commit 4d4e54e

Browse files
committed
Add project-specific installation instructions to README
Enhance README with a new section on project-specific installation for poorcoder. The new section provides detailed guidance on how to copy scripts and prompts into a project, emphasizing customization and workflow flexibility. Also include an example of creating a simple autocommit script to demonstrate practical usage.
1 parent c70f16c commit 4d4e54e

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ Unlike IDE-integrated solutions (Cursor, aider, Claude Code, etc.), poorcoder is
2121

2222
## Installation
2323

24+
### Standard Installation
25+
2426
Simply clone this repository and make the scripts executable:
2527

2628
```bash
@@ -31,6 +33,29 @@ chmod +x context apply-md git-context
3133

3234
You can either use the scripts directly from this folder or add them to your PATH for global access.
3335

36+
### Project-Specific Installation (Recommended)
37+
38+
For heavy usage, copy the scripts and prompts directory directly into your project:
39+
40+
```bash
41+
# Clone the repository
42+
git clone https://github.com/vgrichina/poorcoder.git
43+
# Copy essential files to your project
44+
cp poorcoder/{context,apply-md,git-context} /path/to/your/project/
45+
cp -r poorcoder/prompts /path/to/your/project/
46+
# Make scripts executable
47+
chmod +x /path/to/your/project/{context,apply-md,git-context}
48+
```
49+
50+
This approach lets you customize both the scripts and prompts for your specific project workflow. You can also create custom aliases or wrapper scripts, for example:
51+
52+
```bash
53+
# Create a simple autocommit script
54+
echo '#!/bin/bash
55+
git commit -am "$(./git-context | llm -m openrouter/anthropic/claude-3.5-haiku)" -e' > autocommit
56+
chmod +x autocommit
57+
```
58+
3459
## Scripts
3560

3661
### 1. `context` - Code Context Generator

0 commit comments

Comments
 (0)