aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorhachem <im@hachem.wtf>2026-08-21 15:30:17 +0200
committerhachem <im@hachem.wtf>2026-08-21 15:30:42 +0200
commit3bb376dee410003d32a3b7bd9daef58efaaba908 (patch)
tree09468d6a99cc4e6bc570c1a721652ae748020e2b /README.md
parent45baf48db974c66cfdc51f26cee191abbbd89a0b (diff)
[feat]: abstraction collapse
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 3 insertions, 25 deletions
diff --git a/README.md b/README.md
index 4a1cd9d..db4b448 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,14 @@
-![Logo](branding/Logo-Black.jpg)
+![Logo](branding/Logo-Monochrome-White.jpg)
A real-time black hole ray tracer.
-## 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.
## Screenshots
-![Black Hole with Accretion Disk](Branding/Screenshot1.png)
-![Black hole with HDRI](Branding/Screenshot2.png)
+![Black Hole with Accretion Disk](branding/Screenshot1.png)
+![Black hole with HDRI](branding/Screenshot2.png)
*Real-time rendering of Sagittarius A* with volumetric accretion disk, featuring:*