diff --git a/README.md b/README.md index 40100a9..98587b0 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,15 @@ # Galos -![Galos Starmap Demo](galos_map/demo.gif) -![Galos Galaxy Zoom](galos_map/galaxy.png) ----- [![CI](https://github.com/nixpulvis/galos/actions/workflows/ci.yml/badge.svg)](https://github.com/nixpulvis/galos/actions/workflows/ci.yml) Somewhere between reality and the space/flight sim E:D. +Use `galos-sync` to populate the databas and `galos` to perform basic queries +from the CLI. + +The [`galos-map`](./galos_map) program is a 3D galaxy map, see it's +documentation for more. + ### Database Setup ```sh diff --git a/galos_map/README.md b/galos_map/README.md new file mode 100644 index 0000000..901a720 --- /dev/null +++ b/galos_map/README.md @@ -0,0 +1,10 @@ +# Galos Map +![Galos Starmap Demo](./demo.gif) +![Galos Galaxy Zoom](./galaxy.png) + +```sh +cargo run --release +# Connect to a remote postgresql. +DATABASE_URL postgresql://postgres@10.0.1.32/galos_development \ +cargo run --release +```