You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- These READMEs need to be easy to read in the console, or in whatever
IDE the user is working in, which may not wrap lines, and at word
boundaries. Thus, keep lines to max line length (using 100 here)
- Fixed book links to refer to both the local clone or the official web
site. When browsing from the GitHub repo view, this will show the HTML
source. Locally, both links should launch the rendered form in
browser.
- Fixed Implementations in Other Languages links from old `InOneWeekend`
repo to the new wiki location in `raytracing.github.io`.
- Fixed `main.cc` link to use relative reference, rather than pointing
to the tip of the master branch online (local clones should remain
internally consistent).
- Removed unused link refs in the footer.
- General wording edits.
Copy file name to clipboardExpand all lines: src/InOneWeekend/README.md
+24-12Lines changed: 24 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,34 +3,46 @@ Ray Tracing in One Weekend - Source
3
3
4
4
Content
5
5
--------
6
-
This folder ([InOneWeekend][]) contains the finished code of the [_Ray Tracing in One Weekend_][] book.
6
+
This folder contains the finished code for _Ray Tracing in One Weekend_ ([local][] / [online][]).
7
+
7
8
8
9
Intent
9
10
-------
10
-
This folder is not meant to act as it's own tutorial. The source presented here is provided so that you can compare your work when going along with the book. We strongly recommend reading and following along with the book if you want to understand the source.
11
+
This folder is not meant to act as its own tutorial. The source presented here is provided so you
12
+
can compare your work when progressing through the book. We strongly recommend reading and following
13
+
along with the book to understand the source.
14
+
11
15
12
16
Programming Language
13
17
---------------------
14
-
This book is written in c++ with some modern features of c++11. The code as written is designed to be readable by the largest collection of potential programmers. The code is not meant to illustrate idealized c++ code.
18
+
This book is written in C++, and uses some modern features of C++11. The language and features were
19
+
chosen to be broadly understood by the largest collection of programmers. It is not meant to
20
+
represent ideal C++ code.
21
+
15
22
16
23
Building
17
24
---------
18
-
No mechanism for building is included with this project.
25
+
As the source is intended for illustration & comparison only, it does not include any mechanism for
26
+
building a final program. As far as possible, the code is privately tested on multiple platforms to
27
+
ensure that it is generally usable on any OS (primarily Windows, OSX, and Linux), compiler, or build
28
+
environment.
19
29
20
-
The _Ray Tracing in One Weekend_ series has a long history of being written in other programming languages ([Implementations in Other Languages][]) and across all three primary operating systems.
30
+
It is therefore necessary for you to create your own build tooling. However, the source begins as a
31
+
single main file, and uses only a small collection of additional header files.
21
32
22
-
It is necessary for you to create your own build tooling. However, the source begins as a single main file and builds to only a small collection of additional header files.
33
+
The _Ray Tracing in One Weekend_ series has a long history of implementations in other programming
34
+
languages (see [_Implementations in Other Languages_][implementations]), and across all three
35
+
primary operating systems. Feel free to add your own implementation to the list!
23
36
24
-
The c++ code as written should compile across all three platforms (Win, OSX, Linux).
25
37
26
38
Corrections & Contributions
27
39
----------------------------
28
40
If you spot errors, have suggested corrections, or would like to help out with the project, please
29
-
review the [CONTRIBUTING][]document for the most effective way to proceed.
41
+
review the [CONTRIBUTING][]guidelines for the most effective way to proceed.
Copy file name to clipboardExpand all lines: src/TheNextWeek/README.md
+29-14Lines changed: 29 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,37 +3,52 @@ Ray Tracing: The Next Week - Source
3
3
4
4
Content
5
5
--------
6
-
This folder ([TheNextWeek][]) contains the finished code of the [_Ray Tracing: The Next Week_][] book.
6
+
This folder contains the finished code for _Ray Tracing: The Next Week_ ([local][] / [online][]).
7
+
8
+
Every chapter of the book acts as its own mini tutorial, and each chapter is largely independent of
9
+
other chapters. Every chapter ends with an example render, and in the source, [main.cc][] contains a
10
+
render function specific to each chapter. The source presented here represents the simplest superset
11
+
of the code from all chapters.
7
12
8
-
Every chapter of [_Ray Tracing: The Next Week_][] acts as it's own mini tutorial, and each chapter is largely independent of other chapters. Every chapter ends with an example render, and in the source, the [main.cc][] contains a render function specific to each chapter. The source presented here represents the simplest superset of the code from all chapters.
9
13
10
14
Intent
11
15
-------
12
-
This folder is not meant to act as it's own tutorial. The source presented here is provided so that you can compare your work when going along with the book. We strongly recommend reading and following along with the book if you want to understand the source.
16
+
This folder is not meant to act as its own tutorial. The source presented here is provided so you
17
+
can compare your work when progressing through the book. We strongly recommend reading and following
18
+
along with the book to understand the source.
19
+
13
20
14
21
Programming Language
15
22
---------------------
16
-
This book is written in c++ with some modern features of c++11. The code as written is designed to be readable by the largest collection of potential programmers. The code is not meant to illustrate idealized c++ code.
23
+
This book is written in C++, and uses some modern features of C++11. The language and features were
24
+
chosen to be broadly understood by the largest collection of programmers. It is not meant to
25
+
represent ideal C++ code.
26
+
17
27
18
28
Building
19
29
---------
20
-
No mechanism for building is included with this project.
30
+
As the source is intended for illustration & comparison only, it does not include any mechanism for
31
+
building a final program. As far as possible, the code is privately tested on multiple platforms to
32
+
ensure that it is generally usable on any OS (primarily Windows, OSX, and Linux), compiler, or build
33
+
environment.
21
34
22
-
The _Ray Tracing in One Weekend_ series has a long history of being written in other programming languages ([Implementations in Other Languages][]) and across all three primary operating systems.
35
+
It is therefore necessary for you to create your own build tooling. However, the source begins as a
36
+
single main file, and uses only a small collection of additional header files.
23
37
24
-
It is necessary for you to create your own build tooling. However, the source begins as a single main file and builds to only a small collection of additional header files.
38
+
The _Ray Tracing in One Weekend_ series has a long history of implementations in other programming
39
+
languages (see [_Implementations in Other Languages_][implementations]), and across all three
40
+
primary operating systems. Feel free to add your own implementation to the list!
25
41
26
-
The c++ code as written should compile across all three platforms (Win, OSX, Linux).
27
42
28
43
Corrections & Contributions
29
44
----------------------------
30
45
If you spot errors, have suggested corrections, or would like to help out with the project, please
31
-
review the [CONTRIBUTING][]document for the most effective way to proceed.
46
+
review the [CONTRIBUTING][]guidelines for the most effective way to proceed.
Copy file name to clipboardExpand all lines: src/TheRestOfYourLife/README.md
+25-12Lines changed: 25 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,34 +3,47 @@ Ray Tracing: The Rest Of Your Life - Source
3
3
4
4
Content
5
5
--------
6
-
This folder ([TheRestOfYourLife][]) contains the finished code of the [_Ray Tracing: The Rest Of Your Life_][] book.
6
+
This folder contains the finished code for _Ray Tracing: The Rest Of Your Life_ ([local][] /
7
+
[online][]).
8
+
7
9
8
10
Intent
9
11
-------
10
-
This folder is not meant to act as it's own tutorial. The source presented here is provided so that you can compare your work when going along with the book. We strongly recommend reading and following along with the book if you want to understand the source.
12
+
This folder is not meant to act as its own tutorial. The source presented here is provided so you
13
+
can compare your work when progressing through the book. We strongly recommend reading and following
14
+
along with the book to understand the source.
15
+
11
16
12
17
Programming Language
13
18
---------------------
14
-
This book is written in c++ with some modern features of c++11. The code as written is designed to be readable by the largest collection of potential programmers. The code is not meant to illustrate idealized c++ code.
19
+
This book is written in C++, and uses some modern features of C++11. The language and features were
20
+
chosen to be broadly understood by the largest collection of programmers. It is not meant to
21
+
represent ideal C++ code.
22
+
15
23
16
24
Building
17
25
---------
18
-
No mechanism for building is included with this project.
26
+
As the source is intended for illustration & comparison only, it does not include any mechanism for
27
+
building a final program. As far as possible, the code is privately tested on multiple platforms to
28
+
ensure that it is generally usable on any OS (primarily Windows, OSX, and Linux), compiler, or build
29
+
environment.
19
30
20
-
The _Ray Tracing in One Weekend_ series has a long history of being written in other programming languages ([Implementations in Other Languages][]) and across all three primary operating systems.
31
+
It is therefore necessary for you to create your own build tooling. However, the source begins as a
32
+
single main file, and uses only a small collection of additional header files.
21
33
22
-
It is necessary for you to create your own build tooling. However, the source begins as a single main file and builds to only a small collection of additional header files.
34
+
The _Ray Tracing in One Weekend_ series has a long history of implementations in other programming
35
+
languages (see [_Implementations in Other Languages_][implementations]), and across all three
36
+
primary operating systems. Feel free to add your own implementation to the list!
23
37
24
-
The c++ code as written should compile across all three platforms (Win, OSX, Linux).
25
38
26
39
Corrections & Contributions
27
40
----------------------------
28
41
If you spot errors, have suggested corrections, or would like to help out with the project, please
29
-
review the [CONTRIBUTING][]document for the most effective way to proceed.
42
+
review the [CONTRIBUTING][]guidelines for the most effective way to proceed.
0 commit comments