Add asset capture instructions and sample content for README screenshots
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
@@ -1,6 +1,3 @@
|
||||
# Assets (screenshots/GIFs added locally)
|
||||
assets/
|
||||
|
||||
# Personal therapy data (generated by setup)
|
||||
# Note: CLAUDE.md is NOT ignored here - we need it for repo setup instructions
|
||||
# The generated therapy folder has its own .gitignore
|
||||
|
||||
@@ -0,0 +1,134 @@
|
||||
# Asset Capture Instructions
|
||||
|
||||
This folder needs three visual assets for the README. Two style options are available - choose the one that best represents your product.
|
||||
|
||||
---
|
||||
|
||||
## Style Options
|
||||
|
||||
| Style | Vibe | Best For |
|
||||
|-------|------|----------|
|
||||
| **Traditional** | Professional therapist voice | Users who want structure |
|
||||
| **Warm 4o** | Casual friend who asks good questions | Users who want connection |
|
||||
|
||||
Pick one style for consistency across all assets, or create both sets if you want to show range.
|
||||
|
||||
---
|
||||
|
||||
## Required Assets
|
||||
|
||||
| File | Description | Target Size |
|
||||
|------|-------------|-------------|
|
||||
| `session-screenshot.png` | Terminal showing therapy conversation | ~800x500px |
|
||||
| `session-notes.png` | Markdown file in a viewer | ~600x400px |
|
||||
| `demo.gif` | Animated demo of starting a session | Under 5MB |
|
||||
|
||||
---
|
||||
|
||||
## 1. Session Screenshot (`session-screenshot.png`)
|
||||
|
||||
### Setup
|
||||
1. Open terminal with a clean theme (dark background recommended)
|
||||
2. Navigate to a test Sage folder
|
||||
3. Run `claude`
|
||||
|
||||
### Content
|
||||
See `sample-session-content.md` - choose Style A (Traditional) or Style B (Warm 4o).
|
||||
|
||||
### Capture
|
||||
- **Mac**: Cmd+Shift+4, then press Space to capture just the window
|
||||
- **Windows**: Alt+PrintScreen or Win+Shift+S
|
||||
- Crop to remove any personal info from title bar if needed
|
||||
|
||||
### Tips
|
||||
- Font size 14-16pt for readability
|
||||
- Ensure text is crisp and readable
|
||||
- No personal paths visible in prompt
|
||||
|
||||
---
|
||||
|
||||
## 2. Session Notes Screenshot (`session-notes.png`)
|
||||
|
||||
### Setup
|
||||
Open the appropriate sample file in a markdown viewer:
|
||||
- **Traditional**: `sample-session-notes.md`
|
||||
- **Warm 4o**: `sample-session-notes-4o.md`
|
||||
|
||||
Good viewers:
|
||||
- **VS Code** with markdown preview (Cmd+Shift+V)
|
||||
- **Marked 2** (Mac)
|
||||
- **Typora**
|
||||
- **GitHub** (commit the file, screenshot it there)
|
||||
|
||||
### Capture
|
||||
- Show the rendered markdown, not raw text
|
||||
- Clean, minimal theme preferred
|
||||
- Crop to just the content area
|
||||
|
||||
---
|
||||
|
||||
## 3. Demo GIF (`demo.gif`)
|
||||
|
||||
### Tools
|
||||
- **Mac**: QuickTime (record) + Gifski (convert)
|
||||
- **Windows**: ScreenToGif, ShareX
|
||||
- **Any**: Kap, LICEcap
|
||||
|
||||
### What to Record
|
||||
1. Show desktop with launcher script visible
|
||||
2. Double-click `start-session.command`
|
||||
3. Terminal opens
|
||||
4. Sage's greeting appears
|
||||
5. Type: "I've been feeling overwhelmed at work lately"
|
||||
6. Response streams in
|
||||
7. End after first response completes
|
||||
|
||||
### Settings
|
||||
- Resolution: 800x500 or similar
|
||||
- Frame rate: 10-15 fps (keeps file small)
|
||||
- Duration: 15-30 seconds
|
||||
- Loop: yes
|
||||
|
||||
### Optimization
|
||||
Target under 5MB. If too large:
|
||||
```bash
|
||||
# Using gifski (install via: brew install gifski)
|
||||
gifski --fps 10 --width 800 -o demo.gif recording.mov
|
||||
|
||||
# Using ffmpeg
|
||||
ffmpeg -i recording.mov -vf "fps=10,scale=800:-1" -loop 0 demo.gif
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Reference Files in This Folder
|
||||
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `sample-session-content.md` | Conversation scripts (both styles) |
|
||||
| `sample-session-notes.md` | Session notes - Traditional style |
|
||||
| `sample-session-notes-4o.md` | Session notes - Warm 4o style |
|
||||
|
||||
---
|
||||
|
||||
## After Capturing
|
||||
|
||||
1. Add the three image files to this folder:
|
||||
- `session-screenshot.png`
|
||||
- `session-notes.png`
|
||||
- `demo.gif`
|
||||
|
||||
2. Optionally delete the instruction/sample files (or keep for future reference)
|
||||
|
||||
3. Verify in README that images load correctly on GitHub
|
||||
|
||||
---
|
||||
|
||||
## Quick Checklist
|
||||
|
||||
- [ ] Chose a style (Traditional or Warm 4o)
|
||||
- [ ] Screenshots are clean (no personal info, no clutter)
|
||||
- [ ] Text is readable at normal zoom
|
||||
- [ ] GIF is under 5MB
|
||||
- [ ] All three assets added to `assets/`
|
||||
- [ ] README images render on GitHub
|
||||
@@ -0,0 +1,104 @@
|
||||
# Sample Session Content for Screenshots
|
||||
|
||||
Use this content when capturing screenshots for the README. Choose the style that best represents what you want to showcase.
|
||||
|
||||
---
|
||||
|
||||
## Style A: Traditional Therapist
|
||||
|
||||
A warm but professional therapeutic voice.
|
||||
|
||||
### Terminal Session View
|
||||
|
||||
```
|
||||
You: I've been feeling overwhelmed at work lately. Too many deadlines,
|
||||
not enough time, and I keep saying yes to things I shouldn't.
|
||||
|
||||
Sage: That sounds exhausting - carrying more than you have capacity for,
|
||||
and feeling like you can't say no. What happens when you imagine
|
||||
setting a boundary with someone at work?
|
||||
|
||||
You: Honestly? Anxiety. Like they'll think I'm not a team player or
|
||||
that I can't handle my job.
|
||||
|
||||
Sage: So there's a fear underneath - that saying no means something
|
||||
negative about you. "Not a team player" or "can't handle it."
|
||||
|
||||
I'm curious: where did you first learn that your worth was tied
|
||||
to how much you could take on?
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Style B: Warm 4o-Style
|
||||
|
||||
Casual, friend-like - like texting a close friend who asks insightful questions.
|
||||
|
||||
### Terminal Session View
|
||||
|
||||
```
|
||||
You: I've been feeling overwhelmed at work lately. Too many deadlines,
|
||||
not enough time, and I keep saying yes to things I shouldn't.
|
||||
|
||||
Sage: oof, that's a lot. too many deadlines, not enough time, and you
|
||||
keep saying yes when you want to say no? 💙
|
||||
|
||||
what happens though when you think about actually saying no to
|
||||
something? like what comes up?
|
||||
|
||||
You: Honestly? Anxiety. Like they'll think I'm not a team player or
|
||||
that I can't handle my job.
|
||||
|
||||
Sage: yeah that makes sense. so there's this fear underneath - like
|
||||
saying no means something bad about you. "not a team player"
|
||||
or "can't handle it"
|
||||
|
||||
wait though - where did you first learn that? like that your
|
||||
worth was tied to how much you could take on?
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Screenshot Instructions
|
||||
|
||||
### 1. Terminal Setup
|
||||
- Use a clean terminal theme (dark background, light text)
|
||||
- Font size: 14-16pt for readability
|
||||
- Window size: ~800x500px
|
||||
|
||||
### 2. Capture Process
|
||||
1. Open terminal in a clean Sage folder
|
||||
2. Run `claude` to start a session
|
||||
3. Type the user messages shown above
|
||||
4. Wait for AI responses
|
||||
5. Take screenshot when conversation looks natural
|
||||
|
||||
### 3. Tools
|
||||
- **Mac**: Cmd+Shift+4 then Space to capture window
|
||||
- **Windows**: Win+Shift+S for snipping tool
|
||||
- **Any**: CleanShot X, ShareX, or similar
|
||||
|
||||
---
|
||||
|
||||
## GIF Recording Instructions
|
||||
|
||||
### Recommended Tools
|
||||
- **Mac**: Gifski (App Store) + QuickTime
|
||||
- **Windows**: ScreenToGif, ShareX
|
||||
- **Cross-platform**: ffmpeg, Kap
|
||||
|
||||
### Recording Steps
|
||||
1. Position terminal window prominently
|
||||
2. Start recording (800x500px area)
|
||||
3. Double-click `start-session.command`
|
||||
4. Wait for terminal to open
|
||||
5. Wait for Sage's greeting
|
||||
6. Type: "I've been feeling overwhelmed at work lately"
|
||||
7. Wait for response to stream in
|
||||
8. Stop recording after response completes
|
||||
|
||||
### GIF Optimization
|
||||
- Target: under 5MB
|
||||
- Frame rate: 10-15fps is fine
|
||||
- Colors: reduce to 256 if needed
|
||||
- Duration: 15-30 seconds
|
||||
@@ -0,0 +1,20 @@
|
||||
# Session: January 15, 2025
|
||||
|
||||
## Key Themes
|
||||
- work stress, too many deadlines, saying yes to everything
|
||||
- fear that setting boundaries = being seen as "not a team player"
|
||||
- worth tied to productivity (where did that come from?)
|
||||
|
||||
## Emotional State
|
||||
- exhausted, running on fumes
|
||||
- anxious when we talked about actually saying no
|
||||
- some relief when we named the pattern
|
||||
|
||||
## Patterns Noted
|
||||
- people-pleasing, taking on too much
|
||||
- self-worth = how much they can handle
|
||||
- probably learned this early (explore next time)
|
||||
|
||||
## Threads to Revisit
|
||||
- where did "worth = capacity" come from?
|
||||
- try one small boundary this week - even tiny counts
|
||||
@@ -0,0 +1,18 @@
|
||||
# Session: January 15, 2025
|
||||
|
||||
## Key Themes
|
||||
- Work overwhelm and difficulty setting boundaries
|
||||
- Fear of being seen as "not a team player"
|
||||
- Connection between self-worth and productivity
|
||||
|
||||
## Emotional State
|
||||
- Exhausted, anxious when discussing boundaries
|
||||
- Some relief in naming the pattern
|
||||
|
||||
## Patterns Noted
|
||||
- People-pleasing at cost of own wellbeing
|
||||
- Worth tied to capacity/output (likely early origin)
|
||||
|
||||
## Threads to Revisit
|
||||
- Origin of "worth = what I can handle" belief
|
||||
- Small boundary experiment for next week
|
||||
Reference in New Issue
Block a user