initial commit

1 files changed, 20 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b477add
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# Solar Map
+
+A fast and lightweight V module that reads astronomical dataset records from CSV, encodes them into a portable fixed-size binary format, and renders the spatial distribution to a 24-bit BMP image.
+
+## Features
+
+- **Fast Memory Dump**: Serializes and deserializes spatial objects (`SpaceBody`) using a custom 64-byte binary layout.
+- **Cross-Platform & Safe**: Uses explicit Little-Endian byte-shifting (no `unsafe` blocks), making the binary output completely safe and compatible across different architectures (x86_64, ARM64, RISC-V).
+- **Non-Linear Visual Rendering**: Renders positional data into a 24-bit BMP bitmap with square-root distance scaling to clearly separate both inner and outer space bodies.
+
+## Project Structure
+
+```text
+.
+├── main.v          # Application entry point & binary file IO
+├── galaxy.csv      # Source CSV dataset
+├── galaxy.bin      # Generated binary dataset (created on run)
+├── galaxy.bmp      # Output image (created on run)
+└── render/
+    └── render.v    # Module for BMP rendering and distance scaling