Skip to content

Commit 582be46

Browse files
committed
remove some readme tags and add example
1 parent 0213261 commit 582be46

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33
[![Test Status](https://github.com/da-luce/astroterm/actions/workflows/ci.yml/badge.svg)](https://github.com/da-luce/astroterm/actions?query=branch%3Amain)
44
[![codecov](https://codecov.io/gh/da-luce/astroterm/graph/badge.svg?token=80C0ZQBVTM)](https://codecov.io/gh/da-luce/astroterm)
55
[![Latest release](https://img.shields.io/github/v/release/da-luce/astroterm?label=Latest%20Release&cacheSeconds=3600)](https://github.com/da-luce/astroterm/releases)
6-
[![Homebrew Tap Version](https://img.shields.io/badge/dynamic/json.svg?url=https://raw.githubusercontent.com/da-luce/homebrew-astroterm/main/version.json&query=$.versions.stable&label=Homebrew%20Tap&cacheSeconds=3600)](https://github.com/da-luce/homebrew-astroterm)
7-
[![nixpkgs unstable](https://repology.org/badge/version-for-repo/nix_unstable/astroterm.svg?header=nixpkgs%20unstable)](https://repology.org/project/astroterm/versions)
86
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
97

108
`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!
@@ -13,7 +11,7 @@
1311

1412
![The night sky above Singapore on January 2, 2025](./assets/SG_2025-01-02.gif)
1513

16-
_<p align="center">The night sky above Singapore on January 2, 2025</p>_
14+
_<p align="center">The night sky above Singapore on January 2, 2025<br>See <a href="#example-1">usage</a> on how to obtain this view</p>_
1715

1816
<!-- omit in toc -->
1917
## Table of Contents
@@ -70,7 +68,7 @@ sudo dnf install astroterm
7068

7169
### Homebrew
7270

73-
You can install Astroterm from [Homebrew](https://formulae.brew.sh/formula/astroterm):
71+
You can install `astroterm` from [Homebrew](https://formulae.brew.sh/formula/astroterm) via:
7472

7573
```sh
7674
brew install astroterm
@@ -272,7 +270,24 @@ Usage: astroterm [OPTION]...
272270
```
273271
274272
<!-- omit in toc -->
275-
### Example
273+
### Example 1
274+
275+
To achieve the "spinning globe" effect as shown in the [README GIF](./assets/SG_2025-01-02.gif), use the following flags:
276+
277+
```sh
278+
astroterm --color --constellations --speed 10000 --fps 64 --city Singapore
279+
```
280+
281+
or
282+
283+
```sh
284+
astroterm -cC -s 10000 -f 64 -i Singapore
285+
```
286+
287+
for short. In fact, any [city](./data/cities.csv) around the equator will work. Locations closer to the poles will look different because the apparent motion of the stars is more circular around the celestial pole rather than sweeping across the sky.
288+
289+
<!-- omit in toc -->
290+
### Example 2
276291
277292
Say we wanted to view the sky at 5:00 AM (Eastern) on July 16, 1969—the morning
278293
of the Apollo 11 launch at the Kennedy Space Center in Florida. We would run:

0 commit comments

Comments
 (0)