Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Build instructions for macOS. #163

Merged
merged 1 commit into from
Dec 3, 2024
Merged

Conversation

laosb
Copy link
Contributor

@laosb laosb commented Dec 3, 2024

Summary by Sourcery

Documentation:

  • Add build instructions for macOS to the BUILD.md file, detailing prerequisites and step-by-step guidance for development builds.

Copy link

sourcery-ai bot commented Dec 3, 2024

Reviewer's Guide by Sourcery

This PR adds a new BUILD.md file with detailed instructions for building the Rune project on macOS. The documentation includes prerequisites, step-by-step build instructions, and important notes about code signing configuration for both regular contributors and Inkwire Tech employees.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added comprehensive macOS build documentation
  • Added prerequisites section listing Xcode and Homebrew requirements
  • Included step-by-step instructions for repository setup and dependency installation
  • Added special instructions for Inkwire Tech employees regarding Apple Developer Program
  • Detailed Xcode signing configuration steps for development builds
  • Added build and run script instructions
  • Included warning about not committing signing configuration changes
BUILD.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @laosb - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The clone command is missing in step 1. Please add the actual git clone command with the repository URL.
  • Consider moving Inkwire Tech employee-specific instructions to internal documentation to maintain a cleaner separation between public and private documentation.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.


### Steps

1. Clone the repository:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue: Missing repository URL or clone command

Please provide the git clone command with the repository URL to help users get started.

@Losses Losses merged commit 7f5968c into Losses:master Dec 3, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants