Update the READMEs

nixpulvis · Sep 24, 2024 · 1f7e523 · 1f7e523
1 parent bb84796
commit 1f7e523
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git 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
@@ -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://[email protected]/galos_development \
+cargo run --release
+```