Skip to content

Commit f4d45db

Browse files
simple readme
1 parent d8daebf commit f4d45db

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

Sources/GitDiffExample/README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# GitDiff Example App
2+
3+
An iOS example app showcasing all features of the gitdiff package.
4+
5+
## Running the Example
6+
7+
1. Open the gitdiff package in Xcode
8+
2. Select the `GitDiffExample` scheme from the scheme selector
9+
3. Choose an iOS simulator or device
10+
4. Build and run (⌘R)
11+
12+
## Features Demonstrated
13+
14+
### Examples Tab
15+
- Simple code changes
16+
- File renames
17+
- New files
18+
- Deleted files
19+
- Binary files
20+
- Large diffs with multiple hunks
21+
22+
### Themes Tab
23+
- Interactive theme switcher
24+
- All built-in themes:
25+
- GitHub
26+
- GitLab
27+
- VS Code Light/Dark
28+
- Xcode Light/Dark
29+
30+
### Configuration Tab
31+
- Line numbers toggle
32+
- Font size adjustment (10-20pt)
33+
- Line spacing options (compact, comfortable, spacious)
34+
- Word wrap toggle
35+
- Preset configurations:
36+
- Default
37+
- Code Review
38+
- Mobile
39+
- Presentation
40+
41+
### API Reference Tab
42+
- Code examples for all features
43+
- View modifiers usage
44+
- Configuration object usage
45+
- Custom theme creation
46+
47+
## Code Structure
48+
49+
- `GitDiffExampleApp.swift` - Main app entry point
50+
- `MainTabView.swift` - Tab navigation
51+
- `ExamplesView.swift` - Different diff examples
52+
- `ThemesView.swift` - Theme selection
53+
- `ConfigurationView.swift` - Configuration options
54+
- `APIReferenceView.swift` - API usage examples

0 commit comments

Comments
 (0)