Merge branch 'dev-minor' into dev-major

Author: hollasch

CHANGELOG.md

@@ -8,20 +8,65 @@ Change Log -- Ray Tracing in One Weekend
 # v3.2.0 (in progress)
 
 ### Common
+  - Removed: now that the code handles ray-surface intersection from either side, we no longer need
+    the `flip_face` class, so we've deleted it from the text and from the code (#482, #270)
+
+### _The Next Week_
+  - Removed: Deleted the section covering the old `flip_face` class, renumbered images as this
+    eliminated the rendering with missing Cornell box faces (#482)
   - Change: Renamed and explicitly numbered book images and figures (#495)
+  - Fix: Reduced code duplication in dielectric::scatter() function
   - New: Added alternative constructors that take color arguments in addition to the constructors
     that take `shared_ptr<texture>` arguments, simplifying calling code. This applies to the
     following classes: `checker_texture`, `constant_medium`, `diffuse_light`, and `lambertian`.
     (#516)
+  - Fix: "Intance" typo in Chapter 8.1 to "Instance" (#629)
+
+### _In One Weekend_
+  - Change: Updated all rendered images except for 1.13, 1.14 (#179, #547, #548, #549, #550, #551,
+    #552, #553, #554, #555, #556, #557, #560, #561, #562, #563, #564, #565, #566)
+  - Change: Standard render width changed to 400
+  - Change: Image 6 is now a before-and-after pair to illustrate antialiasing
+  - Change: Listing 48: Refactored material and geometry declarations
+  - Change: Listing 52: Refactored assignment of `etai_over_etat`
+  - Change: Listing 56: Refactored material declarations
+  - Change: Listing 61: Refactored material and geometry declarations
+  - Fix: Corrected various missed change highlights in code listings
+  - Fix: Listing 7: Added missing `color.h`, `vec3.h` includes
+  - Fix: Listing 18: Add missing `double t` member of struct `hit_record` (#428)
+  - Fix: Listing 24: Add missing `color.h` include
+  - Fix: Listing 30: Add missing `camera.h` include
+  - Fix: Listing 42: Don't need to include `ray.h` when using `rtweekend.h`
+  - Fix: Listing 48: Add missing `material.h` include
+  - Fix: Listing 51: `refract()` function was missing `fabs()` on `sqrt()` argument (#559
+  - Fix: Listing 61: Include updated `cam` declaration, show context w/highlighting
+  - Fix: Listing 62: Highlight rename of `camera::get_ray()` parameters to s, t (#616)
+  - Fix: Listing 63: Show reverted scene declarations
+  - Fix: Listing 68: Show final scene render parameters with highlighting
+  - New: Listing 50: Show the updated material definitions
+
+### _The Next Week_
+  - Fix: Listing 7: Show reverted viewing parameters from book 1 final scene
 
 
 ----------------------------------------------------------------------------------------------------
-# v3.1.2 (in progress)
+# v3.1.3 (in progress)
+
+
+----------------------------------------------------------------------------------------------------
+# v3.1.2 (2020-06-03)
+
+### _In One Weekend_
+  - Fix: Correct typo: "Intance Translation" -> "Instance Translation"
+  - Fix: Corrected geometry type when computing distance between two points, final scene (#609)
 
 ### _The Rest of Your Life_
   - Fix: Missing closing parenthesis in listing 10 (#603)
   - Fix: Tiny improvements to the lambertian::scatter() development (#604)
   - Fix: Correct geometry type and unit vector method in `ray_color()`, listing 20 (#606)
+  - Fix: Listing 26: alternate `random_double()` switched `distribution`, `generator` (#621)
+  - Fix: Listing 28, 30: `light_shape` should have default material, not `0` (#607)
+  - Fix: Listing 30: `mixture_pdf` needs `shared_ptr` arguments (#608)
 
 
 ----------------------------------------------------------------------------------------------------

README.md

@@ -21,27 +21,63 @@ versions, use the print function in your browser.
 
 News
 -----
-2020-March-23 — v3.0.0 is out! Following the major v2.0.0 release, we finally had the chance to dig
-into some of the larger changes we'd been wanting to make for a long time. This is a large change
-across the books and entire source code. The new source code now builds using CMake, for most
-platforms and build systems. We've refactored a good deal of the project source, cleaning things up,
-refactoring, adding new functionality where it made sense, and generally trying to simplify the code
-with the goal of making it easier to understand and modify. Finally, this release includes a number
-of changes to areas of the book that have given readers difficulties. Enjoy!
+2020-May-5 — v3.1.0 is out! A smaller minor level patch to iron out a few of the larger things we
+wanted to change after a year of organization. The biggest change in the text is the separation of
+chapters into subchapters. There is no one biggest change in the source, but there are a large
+number of small and significant changes. 
 
 
-Branches
----------
-The `master` branch contains the code at latest release. All ongoing development, with all of the
-latest changes, can be found in the `dev-patch`, `dev-minor`, and `dev-major` branches.
+Directory Structure
+-------------------
+The organization of this repository is meant to be simple and self-evident at a glance:
 
+### books/
+This folder contains the three raytracing books (in HTML), and some supporting material.
 
-Downloading The Source Code
-----------------------------
+### images/
+Contains all of the images and figures of the books. Can also be used to compare your results.
+
+### style/
+Contains the css for the books and the site.
+
+### src/
+Contains the source.
+
+### src/common/
+Contains any headers that are common to two or more books. This is also where external headers
+are stored.
+
+### src/<book>/
+Contains the source specific to any one book. Their is no sharing of source outside of the common
+directory.
+
+
+Source Code
+-----------
+### Intent
+This repository is not meant to act as its own tutorial. The source presented here is provided so
+you can compare your work when progressing through the book. We strongly recommend reading and
+following along with the book to understand the source.
+
+### Downloading The Source Code
 The [GitHub home][] for this project contains all source and documentation associated with the _Ray
 Tracing in One Weekend_ series of books. To clone or download the source code, see the green "Clone
 or download" button in the upper right of the project home page.
 
+### Programming Language
+This book is written in C++, and uses some modern features of C++11. The language and features were
+chosen to be broadly understood by the largest collection of programmers. It is not meant to
+represent ideal C++ code.
+
+### Implementations in Other Languages
+The _Ray Tracing in One Weekend_ series has a long history of implementations in other programming
+languages (see [_Implementations in Other Languages_][implementations]), and across all three
+primary operating systems. Feel free to add your own implementation to the list!
+
+### Branches
+The `master` branch contains the code at latest release. All ongoing development, with all of the
+latest changes, can be found in the `dev-patch`, `dev-minor`, and `dev-major` branches.
+
 
 Building and Running
 ---------------------
@@ -117,3 +153,4 @@ review the [CONTRIBUTING][] document for the most effective way to proceed.
 [web1]:                     https://raytracing.github.io/books/RayTracingInOneWeekend.html
 [web2]:                     https://raytracing.github.io/books/RayTracingTheNextWeek.html
 [web3]:                     https://raytracing.github.io/books/RayTracingTheRestOfYourLife.html
+[implementations]:          https://github.com/RayTracing/raytracing.github.io/wiki/Implementations-in-Other-Languages