Added localized dockerized build instructions with documentation

This commit is contained in:
Alden Do Rosario 2024-12-09 12:09:01 -05:00
parent 07521f06ca
commit 2759fd3640
3 changed files with 50 additions and 0 deletions

27
DOCKER.md Normal file
View file

@ -0,0 +1,27 @@
# Docker Usage Instructions
## Building and Running
1. Build the container:
```bash
docker-compose build
```
2. Start a shell session:
```bash
docker-compose run --rm repo-to-text
```
Once in the shell, you can run repo-to-text:
```bash
# Process current directory
repo-to-text
# Process specific directory
repo-to-text /home/user/myproject
# Use with options
repo-to-text --output-dir /home/user/output
```
The container mounts your home directory at `/home/user`, allowing access to all your projects.