|
3 | 3 | [](https://github.com/da-luce/astroterm/actions?query=branch%3Amain)
|
4 | 4 | [](https://codecov.io/gh/da-luce/astroterm)
|
5 | 5 | [](https://github.com/da-luce/astroterm/releases)
|
6 |
| -[](https://github.com/da-luce/homebrew-astroterm) |
7 |
| -[](https://repology.org/project/astroterm/versions) |
8 | 6 | [](https://opensource.org/licenses/MIT)
|
9 | 7 |
|
10 | 8 | `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 | 11 |
|
14 | 12 | 
|
15 | 13 |
|
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>_ |
17 | 15 |
|
18 | 16 | <!-- omit in toc -->
|
19 | 17 | ## Table of Contents
|
@@ -70,7 +68,7 @@ sudo dnf install astroterm
|
70 | 68 |
|
71 | 69 | ### Homebrew
|
72 | 70 |
|
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: |
74 | 72 |
|
75 | 73 | ```sh
|
76 | 74 | brew install astroterm
|
@@ -272,7 +270,24 @@ Usage: astroterm [OPTION]...
|
272 | 270 | ```
|
273 | 271 |
|
274 | 272 | <!-- 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 |
276 | 291 |
|
277 | 292 | Say we wanted to view the sky at 5:00 AM (Eastern) on July 16, 1969—the morning
|
278 | 293 | of the Apollo 11 launch at the Kennedy Space Center in Florida. We would run:
|
|
0 commit comments