aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorhachem <im@hachem.wtf>2025-08-17 00:01:03 +0200
committerhachem <im@hachem.wtf>2025-08-17 00:01:03 +0200
commitd4ed53752cb3d078e0b79444a3e9a6015c6ff679 (patch)
treed9f9fa94aea2ad781a534175d81ce2daed40b0c7 /README.md
parentdf98427825234b24cfa87ad9f9d8a0d738b3ea13 (diff)
[doc]: Add explanation and documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md49
1 files changed, 47 insertions, 2 deletions
diff --git a/README.md b/README.md
index fa071f6..c6e3a5c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,47 @@
-# 𝔇𝔬𝔫𝔲𝔱
-A realtime blackhole simulator and renderer written in C.
+# 𝔇𝔬𝔫𝔲𝔱 - Black Hole Ray Tracer Documentation
+
+A real-time black hole ray tracer that simulates the visual effects of gravitational lensing around Sagittarius A* (Sgr A*).
+
+## Table of Contents
+
+1. [Overview](#overview)
+2. [Mathematical Theory](docs/mathematical-theory.md)
+ - [Einstein's Field Equations](docs/mathematical-theory.md#einsteins-field-equations)
+ - [Schwarzschild Metric](docs/mathematical-theory.md#schwarzschild-metric)
+ - [Geodesics: Paths of Free-Falling Particles and Light](docs/mathematical-theory.md#geodesics-paths-of-free-falling-particles-and-light)
+ - [Conserved Quantities](docs/mathematical-theory.md#conserved-quantities)
+3. [Ray Tracing Implementation](docs/ray-tracing-implementation.md)
+ - [Ray Initialization](docs/ray-tracing-implementation.md#1-ray-initialization)
+ - [Geodesic Integration](docs/ray-tracing-implementation.md#2-geodesic-integration)
+ - [Intersection Testing](docs/ray-tracing-implementation.md#3-intersection-testing)
+ - [Rendering Pipeline](docs/ray-tracing-implementation.md#4-rendering)
+4. [Numerical Methods](docs/numerical-methods.md)
+ - [Runge-Kutta 4 Integration](docs/numerical-methods.md#runge-kutta-4-rk4-integration--explained)
+ - [Adaptive Step Size](docs/numerical-methods.md#adaptive-step-size)
+ - [Performance Optimizations](docs/numerical-methods.md#performance-optimizations)
+5. [Configuration](docs/configuration.md)
+ - [Configuration Files](docs/configuration.md#configuration-files)
+ - [Simulation Parameters](docs/configuration.md#simulation-parameters)
+ - [Performance Settings](docs/configuration.md#performance-settings)
+
+## Overview
+
+Donut is a real-time black hole ray tracer that simulates the visual effects of gravitational lensing around Sagittarius A* (Sgr A*), the supermassive black hole at the center of our galaxy. The application renders images of how light would bend and distort as it passes near the black hole's intense gravitational field.
+
+## Key Features
+
+- **Real-time Rendering**: GPU-accelerated compute shader implementation
+- **Physically Accurate**: Based on General Relativity equations
+- **Interactive Camera**: Orbital camera system with realistic constraints
+- **Adaptive Performance**: Dynamic step size adjustment for optimal performance
+- **Multiple Objects**: Support for rendering stars and other celestial bodies
+- **Configurable Parameters**: Extensive settings for simulation and graphics
+
+## System Requirements
+
+- **GPU**: OpenGL 4.3+ compatible graphics card
+- **Memory**: 4GB RAM minimum, 8GB recommended
+- **Storage**: 100MB free space
+- **OS**: Windows 10/11, Linux, macOS
+
+For detailed information on each component, please refer to the specific documentation files in the `docs/` folder.