Skip to content

Commit

Permalink
README update, 2020-07-21
Browse files Browse the repository at this point in the history
  • Loading branch information
hollasch committed Jul 21, 2020
1 parent 6438352 commit 7b92650
Showing 1 changed file with 29 additions and 27 deletions.
56 changes: 29 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ These books have been formatted for both screen and print. For printed copies, o
versions, use the print function in your browser.


News
-----
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.
Project Status
---------------
We released [v3.2.0][] on 2020 July 18. Lots of changes; you can jump to the release for more
information. This release focused on books 1 and 2, with new rendered images throughout.

Our current focus is on v3.3.0, which will focus on book 3, _Ray Tracing: The Rest of Your Life_.


Directory Structure
Expand All @@ -47,7 +47,7 @@ Contains the source.
Contains any headers that are common to two or more books. This is also where external headers
are stored.

### src/<book>/
### src/`<book>`/
Contains the source specific to any one book. Their is no sharing of source outside of the common
directory.

Expand All @@ -61,29 +61,30 @@ 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.
Tracing in One Weekend_ book series. 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.
represent ideal (or optimized) 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.
The `master` branch contains the latest released assets. All ongoing development, with all of the
latest changes, can be found in the `dev-patch`, `dev-minor`, and `dev-major` branches. We try to
keep CHANGELOG.md up to date, so you can easily browse what's new in each development branch.


Building and Running
---------------------
Copies of source are provided for you to check your work and compare against. If you wish to build
the provided source, the project uses CMake. At the root of the project directory, run the following
commands to build the debug version of every executable:
the provided source, this project uses CMake. To build, go to the root of the project directory and
run the following commands to create the debug version of every executable:

$ cmake -B build
$ cmake --build build
Expand Down Expand Up @@ -141,16 +142,17 @@ review the [CONTRIBUTING][] document for the most effective way to proceed.



[book1]: books/RayTracingInOneWeekend.html
[book2]: books/RayTracingTheNextWeek.html
[book3]: books/RayTracingTheRestOfYourLife.html
[CONTRIBUTING]: ./CONTRIBUTING.md
[cover1]: images/RTOneWeekend-small.jpg
[cover2]: images/RTNextWeek-small.jpg
[cover3]: images/RTRestOfYourLife-small.jpg
[GitHub home]: https://github.com/RayTracing/raytracing.github.io/
[ImageMagick]: https://imagemagick.org/
[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
[book1]: books/RayTracingInOneWeekend.html
[book2]: books/RayTracingTheNextWeek.html
[book3]: books/RayTracingTheRestOfYourLife.html
[CONTRIBUTING]: CONTRIBUTING.md
[cover1]: images/RTOneWeekend-small.jpg
[cover2]: images/RTNextWeek-small.jpg
[cover3]: images/RTRestOfYourLife-small.jpg
[GitHub home]: https://github.com/RayTracing/raytracing.github.io/
[ImageMagick]: https://imagemagick.org/
[implementations]: https://github.com/RayTracing/raytracing.github.io/wiki/Implementations-in-Other-Languages
[v3.2.0]: https://github.com/RayTracing/raytracing.github.io/releases/tag/v3.2.0
[web1]: https://raytracing.github.io/books/RayTracingInOneWeekend.html
[web2]: https://raytracing.github.io/books/RayTracingTheNextWeek.html
[web3]: https://raytracing.github.io/books/RayTracingTheRestOfYourLife.html

0 comments on commit 7b92650

Please sign in to comment.