Files

T

Claude da73b43b1d Add OpenWhispr easy setup installer and companion files

Single-file bash installer (setup-openwhispr.sh) with distro detection,
dependency installation, STT/AI cleanup provider selection, API key
management, and first-run launch. Includes README, LICENSE (MIT),
CHANGELOG, .gitignore, ShellCheck CI, issue templates, PR template,
and GitHub setup guide.

https://claude.ai/code/session_01XKYC1basxdwtHy71tky7xm

2026-03-25 12:57:53 +00:00

2.3 KiB

Raw Blame History

GitHub Repository Setup Guide

Step-by-step instructions to publish this project on GitHub.

1. Create a new GitHub repository

Go to github.com/new and create a repository:

Name: openwhispr-easy-setup
Description: One-command installer for OpenWhispr on Linux — distro detection, dependencies, API keys, first-run setup
Visibility: Public
Do NOT initialize with README, .gitignore, or license (we already have them)

2. Push local files

cd openwhispr-easy-setup
git init
git add .
git commit -m "Initial release v1.0.0"
git branch -M main
git remote add origin https://github.com/YOUR_USERNAME/openwhispr-easy-setup.git
git push -u origin main

3. Replace YOUR_USERNAME placeholder

Replace YOUR_USERNAME with your actual GitHub username in all files:

sed -i 's/YOUR_USERNAME/your-actual-username/g' setup-openwhispr.sh README.md GITHUB_SETUP.md LICENSE

Then commit:

git add -A
git commit -m "Replace YOUR_USERNAME with actual username"
git push

4. Tag the v1.0.0 release

git tag -a v1.0.0 -m "v1.0.0 — Initial release"
git push origin v1.0.0

Then go to Releases → Draft a new release:

Tag: v1.0.0
Title: v1.0.0 — Initial release
Description: Copy the CHANGELOG.md entries for v1.0.0
Click Publish release

5. Add GitHub topics

Go to your repository page → click the gear icon next to About → add these topics:

linux
voice-dictation
openwhispr
speech-to-text
whisper
easy-install

6. Set repository description

In the same About section, set the description to:

One-command installer for OpenWhispr on Linux — distro detection, dependencies, API keys, first-run setup

7. Verify

README renders correctly with badges
ShellCheck CI runs on push (check Actions tab)
Issue templates appear when creating new issues
PR template appears when opening a pull request
bash <(curl -fsSL https://raw.githubusercontent.com/YOUR_USERNAME/openwhispr-easy-setup/main/setup-openwhispr.sh) works

Done!

Share the one-liner with anyone who wants to install OpenWhispr:

bash <(curl -fsSL https://raw.githubusercontent.com/YOUR_USERNAME/openwhispr-easy-setup/main/setup-openwhispr.sh)

2.3 KiB Raw Blame History