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
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
68 changes: 68 additions & 0 deletions website/docs/quick-start/install-atmos.mdx
Expand Up @@ -78,6 +78,20 @@ Atmos has native packages for macOS and every major Linux distribution. We also
```shell
nix-env -iA nixpkgs.atmos
```

To get the latest version, you may need to update the Nix config to add "unstable" packages.

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 Author

Choose a reason for hiding this comment

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

To be fair, it does say

to get the latest version, you may

If you don't care about the latest version, then these instructions are moot.

```

Then run the following to install:

```shell
nix-shell -p atmos
```
</TabItem>

<TabItem value="go" label="Go">
Expand Down Expand Up @@ -150,3 +164,57 @@ The latest version of Atmos might not be available with third party package mana
- Rename the downloaded file to `atmos` (optional)
- Add the execution bit to the binary (e.g. on Linux and Mac, run `chmod u+x atmos`)
- Place the binary somewhere on your `PATH` (e.g. on Linux and Mac: `mv atmos /usr/local/bin/`)

## Set Up Your Terminal

Atmos is a modern CLI with a Text-based UI (TUI), as such, for the best experience we recommend ensuring you have
a decent terminal and modern fonts installed and configured in your terminal.

### TERM Environment Variable

Atmos uses ANSI color codes. These should work in every modern terminal, including the default terminal shipped with
macOS. You *may* have to set the `TERM` environment variable to `xterm-256color` for it to work.
This can be peristed in your `~/.bashrc` or `~/.zshrc` file (or the respective RC file of whatever shell is in use).
osterman marked this conversation as resolved.
Show resolved Hide resolved

```shell
export TERM=xterm-256color
```

If you're having any troule, try [iTerm2](https://iterm2.com/) or any other modern day terminal that supports
ANSI characters and fonts.

:::tip Install NerdFonts
To display all icons used by `atmos`, we recommend the use of a Nerd Font, like *Fira Code*.
:::

### NerdFonts

Nerd Fonts are popular fonts that are patched to include icons.

The exact process will depend on your terminal and operating system, but the general idea is to install a font that
includes the necessary glyphs and then configure your terminal.

Go to https://www.nerdfonts.com/ for more information.

::tip
We recommend the "Fira Code" NerdFont version, which is what all our screenshots are based on.
:::

<Tabs>
<TabItem value="homebrew-cask-fonts" label="Homebrew">
#### Homebrew

If you're using Homebrew, you can tap the `homebrew-cask-fonts` repository to install Nerd Fonts.

Paste the following into a macOS Terminal window.

```shell
brew tap homebrew/cask-fonts # You only need to do this once!
brew search nerd-font # Search for font packages

# Install the NerdFont version of Fira Code
brew install --cask font-fira-code-nerd-font
```
</TabItem>
</Tabs>

1 change: 1 addition & 0 deletions website/static/install.sh
Expand Up @@ -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
osterman marked this conversation as resolved.
Show resolved Hide resolved
echo "Using Homebrew package manager..."
brew install atmos
}
Expand Down