Skip to content

Commit 2b32128

Browse files
robertmetaclaude
andcommitted
Add comprehensive installation instructions to releases
Improve release notes with detailed install steps: - Download and extract command - Full installation to Emacspeak directories - Emacs configuration example - Requirements clearly stated - Link to full documentation Users can now install directly from release page with copy-paste commands. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 (1M context) <noreply@anthropic.com>
1 parent b97e754 commit 2b32128

1 file changed

Lines changed: 44 additions & 6 deletions

File tree

.github/workflows/release.yml

Lines changed: 44 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -108,26 +108,64 @@ jobs:
108108
fi
109109
110110
# Create release notes
111-
cat > RELEASE_NOTES.md <<EOF
111+
cat > RELEASE_NOTES.md <<'EOF'
112112
## SwiftMac ${VERSION}
113113
114114
**Apple Silicon Release** (arm64)
115115
116-
### Changes
116+
### Requirements
117117
118-
${CHANGES}
118+
- macOS with Apple Silicon (M1, M2, M3, M4, or newer)
119+
- Emacspeak installed
119120
120-
### Download
121+
### Installation
121122
123+
1. **Download and extract:**
122124
\`\`\`bash
123125
curl -L https://github.com/robertmeta/swiftmac/releases/download/v${VERSION}/swiftmac-${VERSION}.tar.gz | tar xz
126+
cd swiftmac
124127
\`\`\`
125128
126-
### Requirements
129+
2. **Install to Emacspeak:**
130+
\`\`\`bash
131+
# Copy binary and frameworks
132+
cp -rf swiftmac ogg.framework vorbis.framework $EMACSPEAK_DIR/servers/
127133
128-
- macOS with Apple Silicon (M1, M2, M3, M4, or newer)
134+
# Copy support scripts
135+
cp cloud-swiftmac log-swiftmac $EMACSPEAK_DIR/servers/
136+
137+
# Copy voice configuration
138+
cp swiftmac-voices.el $EMACSPEAK_DIR/lisp/
139+
140+
# Update .servers file
141+
cd $EMACSPEAK_DIR/servers
142+
echo "swiftmac" >> .servers
143+
echo "log-swiftmac" >> .servers
144+
echo "cloud-swiftmac" >> .servers
145+
sort -u .servers -o .servers
146+
\`\`\`
147+
148+
3. **Configure Emacs:**
149+
Add to your Emacs init file:
150+
\`\`\`elisp
151+
(setenv "EMACSPEAK_DIR" "/path/to/.emacspeak") ; Set your path
152+
(load-file "/path/to/.emacspeak/lisp/emacspeak-setup.el")
153+
(dtk-select-server "swiftmac")
154+
\`\`\`
155+
156+
### Changes
157+
158+
${CHANGES}
159+
160+
---
161+
162+
For more information, see the [full documentation](https://github.com/robertmeta/swiftmac).
129163
EOF
130164
165+
# Substitute VERSION variable
166+
sed -i.bak "s/\${VERSION}/$VERSION/g" RELEASE_NOTES.md
167+
rm RELEASE_NOTES.md.bak
168+
131169
echo "Release notes created"
132170
133171
- name: Create GitHub Release with gh CLI

0 commit comments

Comments
 (0)