docs: Add Homebrew installation instructions for AiderDesk#375
docs: Add Homebrew installation instructions for AiderDesk#375sealad886 wants to merge 6 commits intohotovo:mainfrom
Conversation
Update README.md with install instruction for using Homebrew package manager
There was a problem hiding this comment.
Summary of Changes
Hello @sealad886, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request enhances the user experience for MacOS users by providing clear, concise instructions for managing AiderDesk via Homebrew, a popular package manager. This makes the installation and maintenance process more streamlined for those who prefer using Homebrew.
Highlights
- Documentation Update: Added a new section to README.md detailing how to install, update, and uninstall AiderDesk using Homebrew on MacOS.
- Homebrew Integration: Provided step-by-step instructions for Homebrew users, including commands for installation and uninstallation, and noted that updates should be done within the AiderDesk app itself.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Pull Request Overview
This pull request adds Homebrew installation instructions to the README.md file, providing macOS users with an alternative installation method using the popular package manager. The documentation includes installation, update, and uninstall instructions for the AiderDesk application.
- Added a new "Installation with Package Managers" section with Homebrew-specific instructions
- Included step-by-step commands for installing, updating, and uninstalling AiderDesk via Homebrew
- Added clarification that updates should be done through AiderDesk itself rather than
brew upgrade
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
There was a problem hiding this comment.
Code Review
This pull request adds valuable Homebrew installation instructions to the documentation. My review focuses on refining these instructions to improve clarity, accuracy, and alignment with Homebrew best practices. I've suggested removing the brew update step for a faster user experience, making the install command more explicit with --cask, and clarifying the procedures for updating and uninstalling the application to prevent user confusion, particularly regarding cache removal.
update with --zap flag Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
@sealad886 Since I'm not familiar with the Homebrew Cask process, I'd like to better understand the following:
Thank you. |
wording change Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
Hey @wladimiiir ! First off--thanks for a really cool UI on top of an already pretty awesome CLI tool. :) So, Homebrew is a CLI-based package manager for Mac and Linux. As they say on their website: "Homebrew installs the stuff you need that Apple (or your Linux system) didn’t." If you've used Linux before for more than a cursory period, you'd be familiar with the likes of
Yes, it's designed to auto-update to the latest version based on your Release workflows. Homebrew has bots that trigger when upstream repos release new versions--it's not something I designed myself. There's a regex statement that parses out the |
That's done now. :) |
Add hyperlink to the Installation with Package Managers section on the main README page
corrected link for previoius
|
|
||
| ### Installation | ||
|
|
||
| > [!TIP] |
There was a problem hiding this comment.
This does not really show up as expected. Let's remove it, please.
There was a problem hiding this comment.
The information you have added to the README file should be added here too within the Installation section.
There was a problem hiding this comment.
Does it not show up for you? It looks fine to me:
Also, that's the standard way GitHub recommends adding in tooltips.
In terms of why a link vs adding in text, I'm a major fan of increasing maintainability. For documentation, that means writing something once and then referring to it elsewhere, whenever possible. If it's something that you're really against, I'll absolutely update it--it's your repo, after all. :) Just sharing my thought process anyways.
There was a problem hiding this comment.
This is maybe true when you open it in Github, but the files inside docs-site are used for the documentation website, where the markdown does not have support for such blocks.
Updated uninstallation instructions for AiderDesk.
Update README.md with install instruction for using Homebrew package manager
This pull request adds documentation for installing AiderDesk using Homebrew on MacOS, making it easier for users to manage the application with a package manager.
Documentation improvements:
README.mdwith step-by-step instructions for installing, updating, and uninstalling AiderDesk using Homebrew on MacOS.Homebrew cask for AiderDesk added in Homebrew/homebrew-cask#226001