# 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](https://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

```bash
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/outis1one/openwhispr-easy-setup.git
git push -u origin main
```

## 3. Replace outis1one placeholder

Replace `outis1one` with your actual GitHub username in all files:

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

Then commit:

```bash
git add -A
git commit -m "Replace outis1one with actual username"
git push
```

## 4. Tag the v1.0.0 release

```bash
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](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/outis1one/openwhispr-easy-setup/main/setup-openwhispr.sh)` works

## Done!

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

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