# stargaze -- pretty view of star constellations

the program looks up starfiles in
* `${XDG_DATA_HOME}/stargaze`, defaulting to `~/.local/share`.
* `${prefix}/share/stargaze`, defaulting to /usr/local, but probably set to /usr by your distribution.
* a `stargaze/` folder in the current directory.

see `stargaze -h` for options.

## starfile format

the file is made out of attribute names and data.
the following attributes are supported:
`name` used to generate the fullwidth borders
`quadrant`, `ascension`, `declination`, `area`, and `n_stars`, used to generate the info box.
`star`, which is followed by `<x> <y>` coordenates. the coordenates must be between 0 and 19, inclusive.

## installation

the prefered way to install stargaze is via your distributions package manager.

in the case it's not packaged for you distro, install `notcurses`,
clone this repo or grab the tarball, and use meson to install:

`meson setup -Dbuildtype=release build`
`meson install -C build`

you will be prompted to elevate priveldges.

(or, consider packaging it ~w~)

## known bug

notcurses seems to have a bug when handling escape sequences in specific terminal emulators.

depending on your terminal, rarely it might hang when running. i don't think i can fix this without patching notcurses.