Skip to content

Commit 208d75a

Browse files
authored
Merge pull request #166 from RayTracing/hollasch/README
Update project READMEs + related documents
2 parents 8639924 + b997b1f commit 208d75a

File tree

8 files changed

+221
-34
lines changed

8 files changed

+221
-34
lines changed

COPYING.txt

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
Creative Commons Legal Code
2+
3+
CC0 1.0 Universal
4+
5+
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
6+
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
7+
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
8+
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
9+
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
10+
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
11+
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
12+
HEREUNDER.
13+
14+
Statement of Purpose
15+
16+
The laws of most jurisdictions throughout the world automatically confer
17+
exclusive Copyright and Related Rights (defined below) upon the creator
18+
and subsequent owner(s) (each and all, an "owner") of an original work of
19+
authorship and/or a database (each, a "Work").
20+
21+
Certain owners wish to permanently relinquish those rights to a Work for
22+
the purpose of contributing to a commons of creative, cultural and
23+
scientific works ("Commons") that the public can reliably and without fear
24+
of later claims of infringement build upon, modify, incorporate in other
25+
works, reuse and redistribute as freely as possible in any form whatsoever
26+
and for any purposes, including without limitation commercial purposes.
27+
These owners may contribute to the Commons to promote the ideal of a free
28+
culture and the further production of creative, cultural and scientific
29+
works, or to gain reputation or greater distribution for their Work in
30+
part through the use and efforts of others.
31+
32+
For these and/or other purposes and motivations, and without any
33+
expectation of additional consideration or compensation, the person
34+
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
35+
is an owner of Copyright and Related Rights in the Work, voluntarily
36+
elects to apply CC0 to the Work and publicly distribute the Work under its
37+
terms, with knowledge of his or her Copyright and Related Rights in the
38+
Work and the meaning and intended legal effect of CC0 on those rights.
39+
40+
1. Copyright and Related Rights. A Work made available under CC0 may be
41+
protected by copyright and related or neighboring rights ("Copyright and
42+
Related Rights"). Copyright and Related Rights include, but are not
43+
limited to, the following:
44+
45+
i. the right to reproduce, adapt, distribute, perform, display,
46+
communicate, and translate a Work;
47+
ii. moral rights retained by the original author(s) and/or performer(s);
48+
iii. publicity and privacy rights pertaining to a person's image or
49+
likeness depicted in a Work;
50+
iv. rights protecting against unfair competition in regards to a Work,
51+
subject to the limitations in paragraph 4(a), below;
52+
v. rights protecting the extraction, dissemination, use and reuse of data
53+
in a Work;
54+
vi. database rights (such as those arising under Directive 96/9/EC of the
55+
European Parliament and of the Council of 11 March 1996 on the legal
56+
protection of databases, and under any national implementation
57+
thereof, including any amended or successor version of such
58+
directive); and
59+
vii. other similar, equivalent or corresponding rights throughout the
60+
world based on applicable law or treaty, and any national
61+
implementations thereof.
62+
63+
2. Waiver. To the greatest extent permitted by, but not in contravention
64+
of, applicable law, Affirmer hereby overtly, fully, permanently,
65+
irrevocably and unconditionally waives, abandons, and surrenders all of
66+
Affirmer's Copyright and Related Rights and associated claims and causes
67+
of action, whether now known or unknown (including existing as well as
68+
future claims and causes of action), in the Work (i) in all territories
69+
worldwide, (ii) for the maximum duration provided by applicable law or
70+
treaty (including future time extensions), (iii) in any current or future
71+
medium and for any number of copies, and (iv) for any purpose whatsoever,
72+
including without limitation commercial, advertising or promotional
73+
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
74+
member of the public at large and to the detriment of Affirmer's heirs and
75+
successors, fully intending that such Waiver shall not be subject to
76+
revocation, rescission, cancellation, termination, or any other legal or
77+
equitable action to disrupt the quiet enjoyment of the Work by the public
78+
as contemplated by Affirmer's express Statement of Purpose.
79+
80+
3. Public License Fallback. Should any part of the Waiver for any reason
81+
be judged legally invalid or ineffective under applicable law, then the
82+
Waiver shall be preserved to the maximum extent permitted taking into
83+
account Affirmer's express Statement of Purpose. In addition, to the
84+
extent the Waiver is so judged Affirmer hereby grants to each affected
85+
person a royalty-free, non transferable, non sublicensable, non exclusive,
86+
irrevocable and unconditional license to exercise Affirmer's Copyright and
87+
Related Rights in the Work (i) in all territories worldwide, (ii) for the
88+
maximum duration provided by applicable law or treaty (including future
89+
time extensions), (iii) in any current or future medium and for any number
90+
of copies, and (iv) for any purpose whatsoever, including without
91+
limitation commercial, advertising or promotional purposes (the
92+
"License"). The License shall be deemed effective as of the date CC0 was
93+
applied by Affirmer to the Work. Should any part of the License for any
94+
reason be judged legally invalid or ineffective under applicable law, such
95+
partial invalidity or ineffectiveness shall not invalidate the remainder
96+
of the License, and in such case Affirmer hereby affirms that he or she
97+
will not (i) exercise any of his or her remaining Copyright and Related
98+
Rights in the Work or (ii) assert any associated claims and causes of
99+
action with respect to the Work, in either case contrary to Affirmer's
100+
express Statement of Purpose.
101+
102+
4. Limitations and Disclaimers.
103+
104+
a. No trademark or patent rights held by Affirmer are waived, abandoned,
105+
surrendered, licensed or otherwise affected by this document.
106+
b. Affirmer offers the Work as-is and makes no representations or
107+
warranties of any kind concerning the Work, express, implied,
108+
statutory or otherwise, including without limitation warranties of
109+
title, merchantability, fitness for a particular purpose, non
110+
infringement, or the absence of latent or other defects, accuracy, or
111+
the present or absence of errors, whether or not discoverable, all to
112+
the greatest extent permissible under applicable law.
113+
c. Affirmer disclaims responsibility for clearing rights of other persons
114+
that may apply to the Work or any use thereof, including without
115+
limitation any person's Copyright and Related Rights in the Work.
116+
Further, Affirmer disclaims responsibility for obtaining any necessary
117+
consents, permissions or other rights required for any use of the
118+
Work.
119+
d. Affirmer understands and acknowledges that Creative Commons is not a
120+
party to this document and has no duty or obligation with respect to
121+
this CC0 or use of the Work.

InOneWeekend/README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
Ray Tracing in One Weekend
22
====================================================================================================
33

4-
![Ray Tracing in One Weekend](assets/RTOneWeekend.jpg)
4+
![Ray Tracing in One Weekend](../images/RTOneWeekend.jpg)
55

6-
## Getting the Book
6+
7+
Getting the Book
8+
-----------------
79
The _Ray Tracing in One Weekend_ series of books are now available to the public for free in PDF
810
form, along with the accompanying source code.
911

@@ -12,7 +14,9 @@ Releases are available [directly from GitHub][releases], or from Eric Haines's
1214
[Amazon.com][]. Half of the proceeds of these sales go to [Hack the Hood][], a really neat
1315
organization.
1416

15-
## Overview
17+
18+
Overview
19+
---------
1620
I’ve taught many graphics classes over the years. Often I do them in ray tracing, because you
1721
are forced to write all the code but you can still get cool images with no API. I decided to adapt
1822
my course notes into a how-to, to get you to a cool program as quickly as possible. It will not be
@@ -39,13 +43,17 @@ I have left that last part in because it is funny what a 180 I have done. Severa
3943
up with subtle errors that were helped when we compared code. So please do type in the
4044
code, but if you want to look at mine, here it is.
4145

42-
## Corrections
43-
If you spot errors or have suggested corrections, please [submit issues via GitHub][].
46+
47+
Corrections & Contributions
48+
----------------------------
49+
If you spot errors, have suggested corrections, or would like to help out with the project, please
50+
review the [CONTRIBUTING][] document for the most effective way to proceed.
4451

4552

4653

4754
[Amazon.com]: https://amazon.com/dp/B01B5AODD8
48-
[releases]: https://github.com/raytracing/InOneWeekend/releases/
55+
[CONTRIBUTING]: ../CONTRIBUTING.md
56+
[releases]: https://github.com/raytracing/raytracing.github.io/releases/
4957
[Hack the Hood]: https://hackthehood.org/
5058
[Real-Time Rendering]: https://realtimerendering.com/#books-small-table
51-
[submit issues via GitHub]: https://github.com/raytracing/InOneWeekend/issues/
59+
[submit issues via GitHub]: https://github.com/raytracing/raytracing.github.io/issues/

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
Ray Tracing In One Weekend Book Series
2+
====================================================================================================
3+
4+
| ![Ray Tracing in One Weekend][cover1] | ![Ray Tracing: The Next Week][cover2] | ![Ray Tracing: The Rest Of Your Life][cover3]
5+
|:------------------:|:-----------------:|:-------------------------:|
6+
| [In One Weekend][] | [The Next Week][] | [The Rest Of Your Life][] |
7+
8+
9+
Getting the Books
10+
------------------
11+
The _Ray Tracing in One Weekend_ series of books are now available to the public for free in PDF
12+
form, along with the accompanying source code. Currently, we are also readying the first web release
13+
of these books, for even easier access.
14+
15+
Releases are available [directly from GitHub][releases], or from Eric Haines's
16+
[Real-Time Rendering][] site. Alternatively, you can purchase the Kindle version of this series from
17+
Amazon.com ([In One Weekend][Amazon1], [The Next Week][Amazon2], [The Rest Of Your Life][Amazon3]).
18+
Half of the proceeds of these sales go to [Hack the Hood][], a really neat organization.
19+
20+
21+
Corrections & Contributions
22+
----------------------------
23+
If you spot errors, have suggested corrections, or would like to help out with the project, please
24+
review the [CONTRIBUTING][] document for the most effective way to proceed.
25+
26+
27+
28+
[Amazon1]: https://amazon.com/dp/B01B5AODD8
29+
[Amazon2]: https://amazon.com/dp/B01CO7PQ8C
30+
[Amazon3]: https://amazon.com/dp/B01DN58P8C
31+
[CONTRIBUTING]: ./CONTRIBUTING.md
32+
[cover1]: images/RTOneWeekend-small.jpg
33+
[cover2]: images/RTNextWeek-small.jpg
34+
[cover3]: images/RTRestOfYourLife-small.jpg
35+
[In One Weekend]: InOneWeekend
36+
[releases]: https://github.com/RayTracing/raytracing.github.io/releases/
37+
[Hack the Hood]: https://hackthehood.org/
38+
[Real-Time Rendering]: https://realtimerendering.com/#books-small-table
39+
[submit issues via GitHub]: https://github.com/raytracing/raytracing.github.io/issues/
40+
[The Next Week]: TheNextWeek
41+
[The Rest Of Your Life]: TheRestOfYourLife

TheNextWeek/README.md

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,43 @@
11
Ray Tracing: The Next Week
22
====================================================================================================
33

4-
![Ray Tracing: The Next Week](assets/RTNextWeek.jpg)
4+
![Ray Tracing: The Next Week](../images/RTNextWeek.jpg)
5+
56

67
Getting the Book
78
-----------------
89
The _Ray Tracing in One Weekend_ series of books are now available to the public for free in PDF
9-
form, along with the accompanying source code. Releases are available [directly from GitHub][], or
10-
from Eric Haines's [Real-Time Rendering][] site. Alternatively, you can purchase the Kindle version
11-
of this series from [Amazon.com][]. Half of the proceeds of these sales go to [Hack the Hood][], a
12-
really neat organization.
10+
form, along with the accompanying source code.
11+
12+
Releases are available [directly from GitHub][], or from Eric Haines's [Real-Time Rendering][] site.
13+
Alternatively, you can purchase the Kindle version of this series from [Amazon.com][]. Half of the
14+
proceeds of these sales go to [Hack the Hood][], a really neat organization.
15+
1316

1417
Overview
1518
---------
1619
In [Ray Tracing In One Weekend][], you built a simple brute force path tracer. In this installment
1720
we’ll add textures, volumes (like fog), rectangles, instances, lights, and support for lots of
1821
objects using a BVH. When done, you’ll have a “real” ray tracer.
1922

20-
A heuristic in ray tracing that many peopleincluding mebelieve, is that most optimizations
23+
A heuristic in ray tracing that many people -- including me -- believe, is that most optimizations
2124
complicate the code without delivering much speedup. What I will do in this mini-book is go with the
22-
simplest approach in each design decision I make. Check www.in1weekend.com for readings and
23-
references to a more sophisticated approach. However, I strongly encourage you to do no premature
24-
optimization; if it doesn’t show up high in the execution time profile, it doesn’t need optimization
25-
until all the features are supported!
25+
simplest approach in each design decision I make. Check https://in1weekend.blogspot.com/ for
26+
readings and references to a more sophisticated approach. However, I strongly encourage you to do no
27+
premature optimization; if it doesn’t show up high in the execution time profile, it doesn’t need
28+
optimization until all the features are supported!
2629

2730
The two hardest parts of this book are the BVH and the Perlin textures. This is why the title
2831
suggests you take a week rather than a weekend for this endeavor. But you can save those for last if
2932
you want a weekend project. Order is not very important for the concepts presented in this book, and
3033
without BVH and Perlin texture you will still get a Cornell Box!
3134

32-
## Corrections
33-
If you spot errors or have suggested corrections, please [submit issues via GitHub][].
35+
36+
Corrections & Contributions
37+
----------------------------
38+
If you spot errors, have suggested corrections, or would like to help out with the project, please
39+
review the [CONTRIBUTING][] document for the most effective way to proceed.
40+
3441

3542
Acknowledgments
3643
----------------
@@ -42,8 +49,9 @@ Jean Buckley for editing.
4249

4350

4451
[Amazon.com]: https://amazon.com/dp/B01CO7PQ8C
45-
[directly from GitHub]: https://github.com/raytracing/TheNextWeek/releases/
52+
[CONTRIBUTING]: ../CONTRIBUTING.md
53+
[directly from GitHub]: https://github.com/raytracing/raytracing.github.io/releases/
4654
[Hack the Hood]: http://www.hackthehood.org
47-
[Ray Tracing In One Weekend]: https://github.com/raytracing/InOneWeekend/
55+
[Ray Tracing In One Weekend]: ../InOneWeekend/
4856
[Real-Time Rendering]: http://www.realtimerendering.com/#books-small-table
49-
[submit issues via GitHub]: https://github.com/raytracing/TheNextWeek/issues/
57+
[submit issues via GitHub]: https://github.com/raytracing/raytracing.github.io/issues/

TheRestOfYourLife/README.md

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
Ray Tracing: The Rest Of Your Life
22
====================================================================================================
33

4-
![Ray Tracing: The Rest Of Your Life](assets/RTRestOfYourLife.jpg)
4+
![Ray Tracing: The Rest Of Your Life](../images/RTRestOfYourLife.jpg)
5+
56

67
Getting the Book
78
-----------------
89
The _Ray Tracing in One Weekend_ series of books are now available to the public for free in PDF
9-
form, along with the accompanying source code. Releases are available [directly from GitHub][], or
10-
from Eric Haines's [Real-Time Rendering][] site. Alternatively, you can purchase the Kindle version
11-
of this series from [Amazon.com][]. Half of the proceeds of these sales go to [Hack the Hood][], a
12-
really neat organization.
10+
form, along with the accompanying source code.
11+
12+
Releases are available [directly from GitHub][], or from Eric Haines's [Real-Time Rendering][] site.
13+
Alternatively, you can purchase the Kindle version of this series from [Amazon.com][]. Half of the
14+
proceeds of these sales go to [Hack the Hood][], a really neat organization.
1315

1416

1517
Overview
@@ -26,10 +28,16 @@ is speak in the language of the field that studies those methods. I think of thi
2628
exposure that can be your first of many, and it will equip you with some of the concepts, math, and
2729
terms you will need to study the others.
2830

29-
As before, www.in1weekend.com will have further readings and references.
31+
As before, https://in1weekend.blogspot.com/ will have further readings and references.
32+
33+
34+
Corrections & Contributions
35+
----------------------------
36+
If you spot errors, have suggested corrections, or would like to help out with the project, please
37+
review the [CONTRIBUTING][] document for the most effective way to proceed.
38+
39+
3040

31-
## Corrections
32-
If you spot errors or have suggested corrections, please [submit issues via GitHub][].
3341

3442

3543
Acknowledgements
@@ -47,9 +55,10 @@ book to Markdeep and moving it to the web.
4755

4856

4957
[Amazon.com]: https://amazon.com/dp/B01DN58P8C
50-
[directly from GitHub]: https://github.com/raytracing/TheRestOfYourLife/releases/
58+
[CONTRIBUTING]: ../CONTRIBUTING.md
59+
[directly from GitHub]: https://github.com/raytracing/raytracing.github.io/releases/
5160
[Hack the Hood]: http://www.hackthehood.org/
52-
[Ray Tracing In One Weekend]: https://github.com/raytracing/InOneWeekend/
53-
[Ray Tracing: The Next Week]: https://github.com/raytracing/TheNextWeek/
61+
[Ray Tracing In One Weekend]: ../InOneWeekend/
62+
[Ray Tracing: The Next Week]: ../TheNextWeek/
5463
[Real-Time Rendering]: http://www.realtimerendering.com/#books-small-table
55-
[submit issues via GitHub]: https://github.com/raytracing/TheRestOfYourLife/issues/
64+
[submit issues via GitHub]: https://github.com/raytracing/raytracing.github.io/issues/

images/RTNextWeek-small.jpg

18.7 KB
Loading

images/RTOneWeekend-small.jpg

19.9 KB
Loading

images/RTRestOfYourLife-small.jpg

15 KB
Loading

0 commit comments

Comments
 (0)