@@ -21,6 +21,11 @@ versions, use the print function in your browser.
21
21
22
22
News
23
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.
28
+
24
29
2020-March-23 — v3.0.0 is out! Following the major v2.0.0 release, we finally had the chance to dig
25
30
into some of the larger changes we'd been wanting to make for a long time. This is a large change
26
31
across the books and entire source code. The new source code now builds using CMake, for most
@@ -29,19 +34,59 @@ refactoring, adding new functionality where it made sense, and generally trying
29
34
with the goal of making it easier to understand and modify. Finally, this release includes a number
30
35
of changes to areas of the book that have given readers difficulties. Enjoy!
31
36
37
+ Directory Structure
38
+ -------------------
39
+ The organization of this repository is meant to be simple and self-evident at a glance:
32
40
33
- Branches
34
- ---------
35
- The ` master ` branch contains the code at latest release. All ongoing development, with all of the
36
- latest changes, can be found in the ` dev-patch ` , ` dev-minor ` , and ` dev-major ` branches .
41
+ ### books/
42
+ This folder contains the text of the books in the markdeep markup language. This folder also
43
+ contains the acknowledgments which are shared across all three books. Lastly, it contains
44
+ the javascript for the markdeep script .
37
45
46
+ ### images/
47
+ Contains all of the images and figures of the books. Can also be used to compare your results.
38
48
39
- Downloading The Source Code
40
- ----------------------------
49
+ ### style/
50
+ Contains the css for the books and the site.
51
+
52
+ ### src/
53
+ Contains the source.
54
+
55
+ ### src/common/
56
+ Contains any headers that are common to two or more books. This is also where external headers
57
+ are stored.
58
+
59
+ ### src/<book >/
60
+ Contains the source specific to any one book. Their is no sharing of source outside of the common
61
+ directory.
62
+
63
+ Source Code
64
+ -----------
65
+ ### Intent
66
+ This repository is not meant to act as its own tutorial. The source presented here is provided so
67
+ you can compare your work when progressing through the book. We strongly recommend reading and
68
+ following along with the book to understand the source.
69
+
70
+ ### Downloading The Source Code
41
71
The [ GitHub home] [ ] for this project contains all source and documentation associated with the _ Ray
42
72
Tracing in One Weekend_ series of books. To clone or download the source code, see the green "Clone
43
73
or download" button in the upper right of the project home page.
44
74
75
+ ### Programming Language
76
+ This book is written in C++, and uses some modern features of C++11. The language and features were
77
+ chosen to be broadly understood by the largest collection of programmers. It is not meant to
78
+ represent ideal C++ code.
79
+
80
+ ### Implementations in Other Languages
81
+ The _ Ray Tracing in One Weekend_ series has a long history of implementations in other programming
82
+ languages (see [ _ Implementations in Other Languages_ ] [ implementations ] ), and across all three
83
+ primary operating systems. Feel free to add your own implementation to the list!
84
+
85
+ ### Branches
86
+ The ` master ` branch contains the code at latest release. All ongoing development, with all of the
87
+ latest changes, can be found in the ` dev-patch ` , ` dev-minor ` , and ` dev-major ` branches.
88
+
89
+
45
90
46
91
Building and Running
47
92
---------------------
@@ -117,3 +162,4 @@ review the [CONTRIBUTING][] document for the most effective way to proceed.
117
162
[ web1 ] : https://raytracing.github.io/books/RayTracingInOneWeekend.html
118
163
[ web2 ] : https://raytracing.github.io/books/RayTracingTheNextWeek.html
119
164
[ web3 ] : https://raytracing.github.io/books/RayTracingTheRestOfYourLife.html
165
+ [ implementations ] : https://github.com/RayTracing/raytracing.github.io/wiki/Implementations-in-Other-Languages
0 commit comments