Skip to content

Commit

Permalink
Merge pull request #411 from RayTracing/v3-finalization
Browse files Browse the repository at this point in the history
Final changes for v3.0.0
  • Loading branch information
hollasch authored Mar 23, 2020
2 parents 6b5a788 + aeb7e3a commit 2460c2e
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 6 deletions.
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Change Log -- Ray Tracing in One Weekend
====================================================================================================

----------------------------------------------------------------------------------------------------
# v3.0.0 (in progress) / Current to b3f0bbc 2020-03-21
# v3.0.0 (2020-03-23)

With the migration to a web format accomplished in v2.0.0, we immediately began work on a new major
release: v3.0.0. This release tackles the following key themes:
Expand Down Expand Up @@ -72,9 +72,11 @@ patch-level (fix) changes and some minor-level (addition) changes.

### _In One Weekend_
- Change: Reworked Lambertian reflection text (#155)
- Change: Revised the figure for computing a random reflection vector (#142)
- New: Clarified text around the ideal Lambertian distribution (#155)
- New: Additional explanatory text to the dielectric chapter
- New: Image for hemispherical rendering
- New: Image for dealing with front and back faces (#326)
- Fix: Update `ray_color()` code blocks to match current source (#391)

### _The Next Week_
Expand Down
8 changes: 6 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ raytracing.github.io/ # Repository root
style/ # CSS for books and web site
```

The latest official release can be found in the `master` branch. All ongoing development work (and
all of the latest changes) will be in the `development` branch.


Issues
-------
Expand All @@ -34,7 +37,8 @@ all kinds, even better ways to present something -- just go to the [issues page]

**Before creating a new issue**, please review existing issues to see if someone has already
submitted the same one. Odds are you're not the first to encounter something, so a little quick
research can save everyone some hassle.
research can save everyone some hassle. It's also a good idea to verify that problems still exist in
the `development` branch when creating new issues.

When entering a new issue, please include all relevant information. For content issues, include the
book or books this applies to, and specific locations that should be reviewed. Similarly for code:
Expand All @@ -51,7 +55,7 @@ To contribute a change to the project, please follow these steps:
duplicate other work planned or in progress, and makes sense for the next release.

3. Create your changes in a feature branch (or fork) from the `development` branch (_not_ from
master).
`master`).

4. Follow existing code style.

Expand Down
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,24 @@ These books have been formatted for both screen and print. For printed copies, o
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!


Branches
---------
The `master` branch contains the code at latest release. All ongoing development, with all of the
latest changes, can be found in the `development` branch. If you have issues to file, you may want
to check to see if they're still present in the `development` branch.


Downloading The Source Code
----------------------------
The [GitHub home][] for this project contains all source and documentation associated with the _Ray
Expand Down
2 changes: 1 addition & 1 deletion books/RayTracingInOneWeekend.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
Peter Shirley
edited by Steve Hollasch and Trevor David Black
<br>
Version 3.0.0, 2020-Jan-XX
Version 3.0.0, 2020-Mar-23
<br>
Copyright 2018-2020 Peter Shirley. All rights reserved.

Expand Down
2 changes: 1 addition & 1 deletion books/RayTracingTheNextWeek.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
Peter Shirley
edited by Steve Hollasch and Trevor David Black
<br>
Version 3.0.0, 2020-Jan-XX
Version 3.0.0, 2020-Mar-23
<br>
Copyright 2018-2020 Peter Shirley. All rights reserved.

Expand Down
2 changes: 1 addition & 1 deletion books/RayTracingTheRestOfYourLife.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
Peter Shirley
edited by Steve Hollasch and Trevor David Black
<br>
Version 3.0.0, 2020-Jan-XX
Version 3.0.0, 2020-Mar-23
<br>
Copyright 2018-2020 Peter Shirley. All rights reserved.

Expand Down

0 comments on commit 2460c2e

Please sign in to comment.