update docs

This commit is contained in:
zongor 2025-07-24 14:17:02 -04:00
parent 138db9bda3
commit 4198468b4a
1 changed files with 19 additions and 45 deletions

View File

@ -2,52 +2,45 @@
#+AUTHOR: Charles Kralapp #+AUTHOR: Charles Kralapp
#+OPTIONS: toc:nil num:nil #+OPTIONS: toc:nil num:nil
This project combines a raytracer and an N-body solar system simulation to learn modern C++ (C++03C++23) through practical implementation. This project combines a raytracing in one weekend style raytracer and an N-body solar system simulation to learn modern C++ (C++03C++23) through practical implementation.
* ✅ Project Goals * ✅ Project Goals
- [ ] Simulate solar system using an N-body gravitational algorithm. - [X] Simulate solar system using an N-body gravitational algorithm.
- [ ] Implement a raytracer for rendering bodies and backgrounds. - [X] Implement a raytracer for rendering bodies and backgrounds.
- [ ] Learn and demonstrate features from every major C++ standard. - [ ] Learn and demonstrate features from every major C++ standard.
- [ ] Use open-source tooling: GNU Emacs, Org-mode, GCC, GNU Make.
* 🚀 Toolchain
- Editor: Emacs + Org Mode
- Compiler: GCC/g++
- Build System: GNU Make (no CMake)
- Version Control: Git (optional but recommended)
* 📚 C++ Learning Checklist * 📚 C++ Learning Checklist
** C++03 (Baseline) ** C++03 (Baseline)
- [ ] Classes & Constructors - [X] Classes & Constructors
- [ ] Operator Overloading (`+`, `*`, `[]`) - [X] Operator Overloading (`+`, `*`, `[]`)
- [ ] Manual memory management (`new` / `delete`) - [X] Manual memory management (`new` / `delete`)
- [ ] STL containers: `std::vector`, `std::map` - [X] STL containers: `std::vector`, `std::map`
- [ ] Function overloading - [ ] Function overloading
- [ ] Templates (vector math, utility classes) - [X] Templates (vector math, utility classes)
- [ ] Pointers, references, and const correctness - [X] Pointers, references, and const correctness
- [ ] Namespaces - [ ] Namespaces
- [ ] RAII pattern with destructors - [X] RAII pattern with destructors
- [ ] `std::string`, `std::stringstream` - [X] `std::string`, `std::stringstream`
** C++11 (Modern C++ begins) ** C++11 (Modern C++ begins)
- [ ] `auto` type deduction - [X] `auto` type deduction
- [ ] Range-based for loops - [X] Range-based for loops
- [ ] Lambda expressions - [ ] Lambda expressions
- [ ] `nullptr` - [X] `nullptr`
- [ ] `enum class` - [ ] `enum class`
- [ ] Smart pointers: `std::unique_ptr`, `std::shared_ptr` - [X] Smart pointers: `std::unique_ptr`, `std::shared_ptr`
- [ ] `override`, `final` specifiers - [ ] `override`, `final` specifiers
- [ ] `move` semantics and rvalue references - [ ] `move` semantics and rvalue references
- [ ] `std::array`, `std::tuple` - [X] `std::array`, `std::tuple`
- [ ] Thread support: `std::thread` - [X] Thread support: `std::thread`
** C++14 (Polish & convenience) ** C++14 (Polish & convenience)
- [ ] Generic lambdas (`auto` in lambda parameters) - [ ] Generic lambdas (`auto` in lambda parameters)
- [ ] `decltype(auto)` and improved return type inference - [ ] `decltype(auto)` and improved return type inference
- [ ] `std::make_unique` - [ ] `std::make_unique`
- [ ] Binary literals and digit separators (`0b1010`, `1'000'000`) - [ ] Binary literals and digit separators (`0b1010`, `1'000'000`)
- [ ] Relaxed constexpr functions - [X] Relaxed constexpr functions
- [ ] Using `auto` in lambda captures - [ ] Using `auto` in lambda captures
** C++17 (Simpler and more expressive) ** C++17 (Simpler and more expressive)
@ -70,7 +63,7 @@ This project combines a raytracer and an N-body solar system simulation to learn
- [ ] Expanded constexpr support (e.g., STL algorithms) - [ ] Expanded constexpr support (e.g., STL algorithms)
** C++23 (Final polish) ** C++23 (Final polish)
- [ ] `std::expected` (like Rust's Result<T, E>) - [X] `std::expected` (like Rust's Result<T, E>)
- [ ] `std::mdspan` for multidimensional array views - [ ] `std::mdspan` for multidimensional array views
- [ ] `explicit` lambdas - [ ] `explicit` lambdas
- [ ] More constexpr in the standard library - [ ] More constexpr in the standard library
@ -102,22 +95,3 @@ This project combines a raytracer and an N-body solar system simulation to learn
- [ ] Use `std::expected` for config file errors or simulation errors (C++23) - [ ] Use `std::expected` for config file errors or simulation errors (C++23)
- [ ] Add diagnostics/metrics via coroutines or logging views - [ ] Add diagnostics/metrics via coroutines or logging views
- [ ] Final cleanup using `consteval`, `mdspan`, or advanced features - [ ] Final cleanup using `consteval`, `mdspan`, or advanced features
* 🧪 Testing Ideas
- [ ] Unit tests for vector math and physics (can use C++11 `assert`)
- [ ] Visual verification of orbits and raytraced scene
- [ ] Compare numerical stability over long time steps
* 📂 Directory Layout (suggested)
#+BEGIN_SRC
project-root/
├── Makefile
├── README.org (this file)
└─── src/
├── main.cpp
├── vec3.cpp / .h
├── body.cpp / .h
└─── raytracer/
└── ray.cpp / .h ...
#+END_SRC