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

Updates to Installation Instructions #549

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Updates to Installation Instructions #549

wants to merge 6 commits into from

Conversation

osterman
Copy link
Member

@osterman osterman commented Mar 1, 2024

what

  • Add terminal configuration instructions
  • Add installation instructions for fonts

why

  • Not everyone is familiar with what makes atmos TUI look good =)

@osterman osterman requested review from a team as code owners March 1, 2024 16:44
@osterman osterman changed the title Updates Updates to Installation Instructions Mar 1, 2024
@@ -68,6 +68,7 @@ install_via_binary_download() {
# Function to install via Homebrew
install_via_brew() {
export HOMEBREW_NO_INSTALL_CLEANUP=1
export HOMEBREW_NO_ENV_HINTS=1
Copy link
Member

Choose a reason for hiding this comment

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

Why are we suggesting the overall homebrew config (HOMEBREW_NO_INSTALL_CLEANUP and HOMEBREW_NO_ENV_HINTS)?

Copy link
Member Author

Choose a reason for hiding this comment

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

In our bash install script, we explicitly set the HOMEBREW_NO_INSTALL_CLEANUP and HOMEBREW_NO_ENV_HINTS flags to minimize distractions during the installation process. Although our installer utilizes brew under the hood, the end user is not directly interacting with Homebrew. Therefore, any default hints or messages from Homebrew could be misconstrued as feedback from our installer, which could be misleading. By setting these flags, we streamline the installation experience, ensuring that only pertinent information is displayed. This approach also prevents the Homebrew cleanup messages, which could imply that files are being deleted by our installer, vs brew, which can appear scary. Keep in mind that someone using the installer is probably a novice to begin with, or they would already be using brew natively. Our objective is to keep the installation output as relevant and uncluttered as possible, avoiding any potential confusion for the users.

For example, in `~/.config/nixpkgs/config.nix` add the following line to the file:

```console
nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
Copy link
Member

Choose a reason for hiding this comment

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

I would say that you may need to update your nix config to support the unstable packages channel. I wouldn't make it prescriptive how...that suggestion above means that every package will now be loaded from unstable, which may cause undesired behavior. Some people may prefer stable, then only missing packages from stable are loaded from unstable. And the way you do this is based on how you configure nix (standard, flakes, etc.)

Copy link
Member

@aknysh aknysh left a comment

Choose a reason for hiding this comment

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

one nitpick

Co-authored-by: Andriy Knysh <aknysh@users.noreply.github.com>
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.

None yet

3 participants