Skip to content

Commit 6636f6d

Browse files
docs: Add quick start, contributing, and troubleshooting guides.
1 parent 8a59194 commit 6636f6d

File tree

3 files changed

+154
-0
lines changed

3 files changed

+154
-0
lines changed

CONTRIBUTING.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing to git-chronoscope!
4+
5+
## Development Setup
6+
7+
```bash
8+
# Clone repository
9+
git clone https://github.com/user/git-chronoscope.git
10+
cd git-chronoscope
11+
12+
# Create virtual environment
13+
python -m venv venv
14+
source venv/bin/activate # On Windows: venv\Scripts\activate
15+
16+
# Install dependencies
17+
pip install -r requirements.txt
18+
pip install -r requirements-dev.txt # For testing
19+
```
20+
21+
## Running Tests
22+
23+
```bash
24+
python -m unittest discover tests
25+
```
26+
27+
## Pull Request Process
28+
29+
1. Fork the repository
30+
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
31+
3. Make changes and add tests
32+
4. Run tests (`python -m unittest discover tests`)
33+
5. Commit (`git commit -m 'Add amazing feature'`)
34+
6. Push (`git push origin feature/amazing-feature`)
35+
7. Open a Pull Request
36+
37+
## Code Style
38+
39+
- Follow PEP 8
40+
- Use type hints where possible
41+
- Add docstrings to functions and classes
42+
- Keep functions focused and small
43+
44+
## Questions?
45+
46+
Open an issue for questions or discussions.

QUICKSTART.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Quick Start
2+
3+
Generate your first time-lapse in 5 minutes.
4+
5+
## 1. Install
6+
7+
```bash
8+
# Clone
9+
git clone https://github.com/user/git-chronoscope.git
10+
cd git-chronoscope
11+
12+
# Install dependencies
13+
pip install -r requirements.txt
14+
```
15+
16+
## 2. Prerequisites
17+
18+
- Git installed
19+
- FFmpeg installed (for video output)
20+
21+
## 3. Generate Time-Lapse
22+
23+
```bash
24+
# Basic usage
25+
python -m src.main /path/to/your/repo output.mp4
26+
27+
# With options
28+
python -m src.main /path/to/repo output.mp4 --fps 10 --resolution 1080p
29+
```
30+
31+
## 4. View Result
32+
33+
Open `output.mp4` to see your repository's evolution!
34+
35+
## Common Options
36+
37+
| Option | Description |
38+
|--------|-------------|
39+
| `--fps 10` | Frames per second |
40+
| `--resolution 1080p` | Video resolution |
41+
| `--format gif` | Output as GIF |
42+
| `--include "*.py"` | Filter files |
43+
| `--dry-run` | Preview without generating |
44+
45+
## Next Steps
46+
47+
- See `README.md` for full documentation
48+
- See `TROUBLESHOOTING.md` if you encounter issues

TROUBLESHOOTING.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Troubleshooting
2+
3+
Common problems and solutions.
4+
5+
## FFmpeg Not Found
6+
7+
**Error:** `FFmpeg not found in PATH`
8+
9+
**Solution:**
10+
```bash
11+
# macOS
12+
brew install ffmpeg
13+
14+
# Ubuntu/Debian
15+
sudo apt-get install ffmpeg
16+
17+
# Windows
18+
winget install FFmpeg.FFmpeg
19+
```
20+
21+
## Git Not Found
22+
23+
**Error:** `git: command not found`
24+
25+
**Solution:** Install Git from https://git-scm.com/downloads
26+
27+
## No Commits Found
28+
29+
**Error:** `No commits found in the specified branch`
30+
31+
**Solutions:**
32+
- Verify the repository path is correct
33+
- Check if the branch exists: `git branch -a`
34+
- Ensure repository is not a shallow clone
35+
36+
## Out of Memory
37+
38+
**Error:** Process killed or memory errors
39+
40+
**Solutions:**
41+
- Use `--sample-rate 10` to skip commits
42+
- Use `--max-commits 500` to limit commits
43+
- Use `--include "*.py"` to filter files
44+
45+
## Permission Denied
46+
47+
**Error:** Cannot write output file
48+
49+
**Solution:** Check write permissions for output directory
50+
51+
## Slow Performance
52+
53+
**Solutions:**
54+
- Use `--workers 4` for parallel processing
55+
- Use `--sample-rate N` to skip commits
56+
- Use `--use-cache` for repeated runs
57+
58+
## Still Having Issues?
59+
60+
Open an issue at: https://github.com/user/git-chronoscope/issues

0 commit comments

Comments
 (0)