Skip to content

Commit b44aa91

Browse files
committed
Merge branch 'master' into dev-patch
2 parents 20987fb + 7b92650 commit b44aa91

File tree

1 file changed

+29
-27
lines changed

1 file changed

+29
-27
lines changed

README.md

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ These books have been formatted for both screen and print. For printed copies, o
1919
versions, use the print function in your browser.
2020

2121

22-
News
23-
-----
24-
2020-May-5 — v3.1.0 is out! A smaller minor level patch to iron out a few of the larger things we
25-
wanted to change after a year of organization. The biggest change in the text is the separation of
26-
chapters into subchapters. There is no one biggest change in the source, but there are a large
27-
number of small and significant changes.
22+
Project Status
23+
---------------
24+
We released [v3.2.0][] on 2020 July 18. Lots of changes; you can jump to the release for more
25+
information. This release focused on books 1 and 2, with new rendered images throughout.
26+
27+
Our current focus is on v3.3.0, which will focus on book 3, _Ray Tracing: The Rest of Your Life_.
2828

2929

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

50-
### src/<book>/
50+
### src/`<book>`/
5151
Contains the source specific to any one book. Their is no sharing of source outside of the common
5252
directory.
5353

@@ -61,29 +61,30 @@ following along with the book to understand the source.
6161

6262
### Downloading The Source Code
6363
The [GitHub home][] for this project contains all source and documentation associated with the _Ray
64-
Tracing in One Weekend_ series of books. To clone or download the source code, see the green "Clone
65-
or download" button in the upper right of the project home page.
64+
Tracing in One Weekend_ book series. To clone or download the source code, see the green "Clone or
65+
download" button in the upper right of the project home page.
6666

6767
### Programming Language
6868
This book is written in C++, and uses some modern features of C++11. The language and features were
6969
chosen to be broadly understood by the largest collection of programmers. It is not meant to
70-
represent ideal C++ code.
70+
represent ideal (or optimized) C++ code.
7171

7272
### Implementations in Other Languages
7373
The _Ray Tracing in One Weekend_ series has a long history of implementations in other programming
7474
languages (see [_Implementations in Other Languages_][implementations]), and across all three
7575
primary operating systems. Feel free to add your own implementation to the list!
7676

7777
### Branches
78-
The `master` branch contains the code at latest release. All ongoing development, with all of the
79-
latest changes, can be found in the `dev-patch`, `dev-minor`, and `dev-major` branches.
78+
The `master` branch contains the latest released assets. All ongoing development, with all of the
79+
latest changes, can be found in the `dev-patch`, `dev-minor`, and `dev-major` branches. We try to
80+
keep CHANGELOG.md up to date, so you can easily browse what's new in each development branch.
8081

8182

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

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

142143

143144

144-
[book1]: books/RayTracingInOneWeekend.html
145-
[book2]: books/RayTracingTheNextWeek.html
146-
[book3]: books/RayTracingTheRestOfYourLife.html
147-
[CONTRIBUTING]: ./CONTRIBUTING.md
148-
[cover1]: images/RTOneWeekend-small.jpg
149-
[cover2]: images/RTNextWeek-small.jpg
150-
[cover3]: images/RTRestOfYourLife-small.jpg
151-
[GitHub home]: https://github.com/RayTracing/raytracing.github.io/
152-
[ImageMagick]: https://imagemagick.org/
153-
[web1]: https://raytracing.github.io/books/RayTracingInOneWeekend.html
154-
[web2]: https://raytracing.github.io/books/RayTracingTheNextWeek.html
155-
[web3]: https://raytracing.github.io/books/RayTracingTheRestOfYourLife.html
156-
[implementations]: https://github.com/RayTracing/raytracing.github.io/wiki/Implementations-in-Other-Languages
145+
[book1]: books/RayTracingInOneWeekend.html
146+
[book2]: books/RayTracingTheNextWeek.html
147+
[book3]: books/RayTracingTheRestOfYourLife.html
148+
[CONTRIBUTING]: CONTRIBUTING.md
149+
[cover1]: images/RTOneWeekend-small.jpg
150+
[cover2]: images/RTNextWeek-small.jpg
151+
[cover3]: images/RTRestOfYourLife-small.jpg
152+
[GitHub home]: https://github.com/RayTracing/raytracing.github.io/
153+
[ImageMagick]: https://imagemagick.org/
154+
[implementations]: https://github.com/RayTracing/raytracing.github.io/wiki/Implementations-in-Other-Languages
155+
[v3.2.0]: https://github.com/RayTracing/raytracing.github.io/releases/tag/v3.2.0
156+
[web1]: https://raytracing.github.io/books/RayTracingInOneWeekend.html
157+
[web2]: https://raytracing.github.io/books/RayTracingTheNextWeek.html
158+
[web3]: https://raytracing.github.io/books/RayTracingTheRestOfYourLife.html

0 commit comments

Comments
 (0)