Add installation commands & TOC to README#1848
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @cyb3rko, 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 significantly enhances the README.md by improving its navigability and broadening its scope for tool installation. It introduces a Table of Contents to help users quickly find relevant sections and adds specific installation commands for Arch Linux users via yay, making the setup process more inclusive.
Highlights
- README Navigation: A Table of Contents (TOC) has been added to the
README.mdto provide quick navigation to various sections, improving the document's usability. - Tool Installation: Installation instructions for required tools have been expanded to include
yaycommands for Arch Linux users, complementing the existingbrewinstructions and making them more accessible.
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 or fill out our survey to provide feedback.
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.
Code Review
This pull request improves the README.md by adding a Table of Contents for better navigation and includes installation instructions for Arch Linux users via yay. The changes are well-structured using <details> tags. I've made one suggestion to use the correct package name for the Hetzner CLI on Arch Linux to ensure the command is explicit and reliable.
| yay terraform # OR yay opentofu | ||
| yay packer | ||
| yay kubectl | ||
| yay hcloud |
There was a problem hiding this comment.
Thanks for adding the yay commands! The package name for the Hetzner CLI in the Arch User Repository (AUR) is hcloud-cli. Using the correct package name is more explicit and reliable, even though yay's search functionality might find it.
| yay hcloud | |
| yay hcloud-cli |
There was a problem hiding this comment.
I don't think so (see entries 1 + 2).
It's just called "hcloud".
|
@cyb3rko Appreciate it very much, I value the effort, but commands specific to arch linux are not generic enough. If that's so, why not add fedora, ubuntu, opensuse, it won't finish. That's why I chose brew, and people can figure it out. Any specification needs to be generic enough. But thanks again, it's just that I do not feel this is important enough, arch especially is a tiny niche of gurus, you folks can figure out that you can use yay already :) No hard feelings please! Keep up the good work. |
|
@mysticaltech I don't think it's nieche.
And almost all bigger projects offer different installation instructions, so not every single user has to do research on how the packages are called on their distro. |
There was a problem hiding this comment.
@cyb3rko I appreciate your insistance. If that's the case, could you push this instead with regards to the tools (or something close), and I would merge it ASAP.
Tool Installation
Quick Install Commands
Install all required tools with one command:
| Platform | Command |
|---|---|
| macOS/Linux (Homebrew) | brew install terraform packer kubectl hcloud |
| Arch-based (AUR) | yay -S terraform packer kubectl hcloud |
| Debian/Ubuntu | sudo apt install terraform packer kubectl |
| Fedora/RHEL | sudo dnf install terraform packer kubectl |
| Snap | sudo snap install terraform kubectl --classic && snap install packer |
| Windows (Chocolatey) | choco install terraform packer kubernetes-cli hetzner-cli |
|
As for the TOC, that's awesome too, keep it! I actually missed that last time, super good addition. |
|
I pushed it. I have not tried out every command, I trust you there :) |
cyb3rko
changed the title
mysticaltech
left a comment
mysticaltech
left a comment
There was a problem hiding this comment.
Thanks @cyb3rko, really appreciate it! This makes the readme way better and complete. Your insistence was worth it.
2 participants
I've added tool installation commands for yay (Arch Linux) as an alternative to brew (referring to #1802).
Furthermore there's now a table of contents of the high-level headings for finding things much faster in the README, because at this point the README is pretty huge.
If not wanted, however, I will revert that commit.