docs: add user-facing README and contributor guide#24
Merged
Conversation
Signed-off-by: Sertac Ozercan <sozercan@gmail.com>
There was a problem hiding this comment.
Pull request overview
Refocuses user documentation and separates contributor workflows.
Changes:
- Adds streamlined installation, Finder setup, usage, and permissions guidance.
- Moves development, testing, packaging, and release instructions into
CONTRIBUTING.md.
Show a summary per file
| File | Description |
|---|---|
README.md |
Provides user-facing setup and usage guidance. |
CONTRIBUTING.md |
Documents development and release workflows. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 2
- Review effort level: Medium
|
|
||
| ## Development requirements | ||
|
|
||
| - macOS 12 or newer |
|
|
||
| Pushing a `v*` tag runs `.github/workflows/release.yml`. The workflow builds a universal app, signs it, creates a GitHub release, and updates `Casks/open-in-code.rb` in [`sozercan/homebrew-repo`](https://github.com/sozercan/homebrew-repo). | ||
|
|
||
| Public releases require all of these GitHub Actions secrets: |
Signed-off-by: Sertac Ozercan <sozercan@gmail.com>
|
|
||
| ## Development requirements | ||
|
|
||
| - macOS 12 or newer |
|
|
||
| Pushing a `v*` tag runs `.github/workflows/release.yml`. The workflow builds a universal app, signs it, creates a GitHub release, and updates `Casks/open-in-code.rb` in [`sozercan/homebrew-repo`](https://github.com/sozercan/homebrew-repo). | ||
|
|
||
| Public releases require all of these GitHub Actions secrets: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
CONTRIBUTING.mdValidation
git diff --check