Skip to content

Commit 6632111

Browse files
hollaschhollasch
committed
Update all documentation for v4.0.0-alpha.1
1 parent 8bb3112 commit 6632111

File tree

8 files changed

+77
-214
lines changed

8 files changed

+77
-214
lines changed

‎README.md‎

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,19 @@ Ray Tracing in One Weekend Book Series
99
Getting the Books
1010
------------------
1111
The _Ray Tracing in One Weekend_ series of books are now available to the public for free directly
12-
from the web:
12+
from the web.
13+
14+
We are currently hosting both the older v3.2.3 version and the v4.0.0-alpha.1 versions in the same
15+
project. The older v3 version is provide for readers who are in the middle of going through the
16+
series so you can maintain continuity. For new readers, or readers newly starting one of the books,
17+
we strongly recommend that you jump above the v4 train.
18+
19+
### Version 3.2.3
20+
- [Ray Tracing in One Weekend][web1-v3]
21+
- [Ray Tracing: The Next Week][web2-v3]
22+
- [Ray Tracing: The Rest of Your Life][web3-v3]
23+
24+
### Version 4.0.0-alpha.1
1325

1426
- [Ray Tracing in One Weekend][web1]
1527
- [Ray Tracing: The Next Week][web2]
@@ -21,18 +33,15 @@ versions, use the print function in your browser.
2133

2234
Project Status
2335
---------------
24-
We are driving toward our v4.0.0 release for book 1 by SIGGRAPH 2023 (August 6). It's been a long
25-
journey from v3.2.3, released December 2020, but we're seeing the finish line. We hope to have books
26-
2 & 3 ready by the end of 2023.
36+
Version v4.0.0-alpha.1 is now released for SIGGRAPH 2023. Book 1 is largely completed, and we are
37+
driving books 2 and 3 to completion, with a final release date by the end of 2023. It's been a long
38+
journey from v3.2.3, released December 2020, but we're seeing the finish line.
2739

28-
If you'd like to check out the latest and watch our progress, we're on the `dev-major` branch. Our
29-
relevant milestones are
40+
If you'd like to check out the latest updates and watch our progress, we're on the `dev-major`
41+
branch. Our relevant milestones are
3042

31-
- [v4.0.0 Book 1](https://github.com/RayTracing/raytracing.github.io/milestone/20)
32-
- [v4.0.0 Book 1 Release](https://github.com/RayTracing/raytracing.github.io/milestone/21)
33-
- [v4.0.0 Book 2](https://github.com/RayTracing/raytracing.github.io/milestone/24)
34-
- [v4.0.0 Book 3](https://github.com/RayTracing/raytracing.github.io/milestone/22)
35-
- [v4.0.0 Books 2 & 3 Release](https://github.com/RayTracing/raytracing.github.io/milestone/23)
43+
- [v4.0.0](https://github.com/RayTracing/raytracing.github.io/milestone/16)
44+
- [v4.0.0-release](https://github.com/RayTracing/raytracing.github.io/milestone/19)
3645

3746
Let us know if you'd like to help out. If you have a change you'd like to contribute,
3847
_**[please see our contribution guidelines][CONTRIBUTING]**_.
@@ -69,6 +78,9 @@ The organization of this repository is meant to be simple and self-evident at a
6978
Contains the source specific to any one book. There is no sharing of source outside of the
7079
common directory.
7180

81+
- `v3/` --
82+
All content (same general structure) for the v3.2.3 release (from December 2020).
83+
7284

7385
Source Code
7486
-----------
@@ -166,9 +178,9 @@ _**please review the [CONTRIBUTING][] document for the most effective way to pro
166178
[book2]: books/RayTracingTheNextWeek.html
167179
[book3]: books/RayTracingTheRestOfYourLife.html
168180
[CONTRIBUTING]: CONTRIBUTING.md
169-
[cover1]: images/RTOneWeekend-small.jpg
170-
[cover2]: images/RTNextWeek-small.jpg
171-
[cover3]: images/RTRestOfYourLife-small.jpg
181+
[cover1]: images/cover/CoverRTW1-small.jpg
182+
[cover2]: images/cover/CoverRTW2-small.jpg
183+
[cover3]: images/cover/CoverRTW3-small.jpg
172184
[discussions]: https://github.com/RayTracing/raytracing.github.io/discussions/
173185
[GitHub home]: https://github.com/RayTracing/raytracing.github.io/
174186
[ImageMagick]: https://imagemagick.org/
@@ -177,5 +189,8 @@ _**please review the [CONTRIBUTING][] document for the most effective way to pro
177189
[milestone 19]: https://github.com/RayTracing/raytracing.github.io/milestone/19
178190
[v3.2.3]: https://github.com/RayTracing/raytracing.github.io/releases/tag/v3.2.3
179191
[web1]: https://raytracing.github.io/books/RayTracingInOneWeekend.html
192+
[web1-v3]: https://raytracing.github.io/books/v3/RayTracingInOneWeekend.html
180193
[web2]: https://raytracing.github.io/books/RayTracingTheNextWeek.html
194+
[web2-v3]: https://raytracing.github.io/books/v3/RayTracingTheNextWeek.html
181195
[web3]: https://raytracing.github.io/books/RayTracingTheRestOfYourLife.html
196+
[web3-v3]: https://raytracing.github.io/books/v3/RayTracingTheRestOfYourLife.html

‎books/RayTracingInOneWeekend.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
**Ray Tracing in One Weekend**
88
[Peter Shirley][], [Trevor David Black][], [Steve Hollasch][]
99
<br>
10-
Version 4.0.0-alpha, 2023-XX-XX
10+
Version 4.0.0-alpha.1, 2023-08-06
1111
<br>
1212
Copyright 2018-2023 Peter Shirley. All rights reserved.
1313

@@ -4165,8 +4165,8 @@
41654165
- **Title (series)**: “Ray Tracing in One Weekend Series”
41664166
- **Title (book)**: “Ray Tracing in One Weekend”
41674167
- **Author**: Peter Shirley, Trevor David Black, Steve Hollasch
4168-
- **Version/Edition**: v4.0.0-alpha
4169-
- **Date**: 2023-XX-XX
4168+
- **Version/Edition**: v4.0.0-alpha.1
4169+
- **Date**: 2023-08-06
41704170
- **URL (series)**: https://raytracing.github.io/
41714171
- **URL (book)**: https://raytracing.github.io/books/RayTracingInOneWeekend.html
41724172

@@ -4193,7 +4193,7 @@
41934193
title = {Ray Tracing in One Weekend},
41944194
author = {Peter Shirley, Trevor David Black, Steve Hollasch},
41954195
year = {2023},
4196-
month = {XXXXXXXXX},
4196+
month = {August},
41974197
note = {\small \texttt{https://raytracing.github.io/books/RayTracingInOneWeekend.html}},
41984198
url = {https://raytracing.github.io/books/RayTracingInOneWeekend.html}
41994199
}
@@ -4209,7 +4209,7 @@
42094209
title = {Ray Tracing in One Weekend},
42104210
author = {Peter Shirley, Trevor David Black, Steve Hollasch},
42114211
year = {2023},
4212-
month = {XXXXXXXXX},
4212+
month = {August},
42134213
url = {https://raytracing.github.io/books/RayTracingInOneWeekend.html}
42144214
}
42154215
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

‎books/RayTracingTheNextWeek.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
**Ray Tracing: The Next Week**
88
[Peter Shirley][], [Trevor David Black][], [Steve Hollasch][]
99
<br>
10-
Version 4.0.0-alpha, 2023-XX-XX
10+
Version 4.0.0-alpha.1, 2023-08-06
1111
<br>
1212
Copyright 2018-2023 Peter Shirley. All rights reserved.
1313

@@ -4005,8 +4005,8 @@
40054005
- **Title (series)**: “Ray Tracing in One Weekend Series”
40064006
- **Title (book)**: “Ray Tracing: The Next Week”
40074007
- **Author**: Peter Shirley, Trevor David Black, Steve Hollasch
4008-
- **Version/Edition**: v4.0.0-alpha
4009-
- **Date**: 2023-XX-XX
4008+
- **Version/Edition**: v4.0.0-alpha.1
4009+
- **Date**: 2023-08-06
40104010
- **URL (series)**: https://raytracing.github.io/
40114011
- **URL (book)**: https://raytracing.github.io/books/RayTracingTheNextWeek.html
40124012

@@ -4033,7 +4033,7 @@
40334033
title = {Ray Tracing: The Next Week},
40344034
author = {Peter Shirley, Trevor David Black, Steve Hollasch},
40354035
year = {2023},
4036-
month = {XXXXXXXX},
4036+
month = {August},
40374037
note = {\small \texttt{https://raytracing.github.io/books/RayTracingTheNextWeek.html}},
40384038
url = {https://raytracing.github.io/books/RayTracingTheNextWeek.html}
40394039
}
@@ -4049,7 +4049,7 @@
40494049
title = {Ray Tracing: The Next Week},
40504050
author = {Peter Shirley, Trevor David Black, Steve Hollasch},
40514051
year = {2023},
4052-
month = {XXXXXXXX},
4052+
month = {August},
40534053
url = {https://raytracing.github.io/books/RayTracingTheNextWeek.html}
40544054
}
40554055
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

‎books/RayTracingTheRestOfYourLife.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
**Ray Tracing: The Rest of Your Life**
88
[Peter Shirley][], [Trevor David Black][], [Steve Hollasch][]
99
<br>
10-
Version 4.0.0-alpha, 2023-XX-XX
10+
Version 4.0.0-alpha.1, 2023-08-06
1111
<br>
1212
Copyright 2018-2023 Peter Shirley. All rights reserved.
1313

@@ -3763,8 +3763,8 @@
37633763
- **Title (series)**: “Ray Tracing in One Weekend Series”
37643764
- **Title (book)**: “Ray Tracing: The Rest of Your Life”
37653765
- **Author**: Peter Shirley, Trevor David Black, Steve Hollasch
3766-
- **Version/Edition**: v4.0.0-alpha
3767-
- **Date**: 2023-XX-XX
3766+
- **Version/Edition**: v4.0.0-alpha.1
3767+
- **Date**: 2023-08-06
37683768
- **URL (series)**: https://raytracing.github.io/
37693769
- **URL (book)**: https://raytracing.github.io/books/RayTracingTheRestOfYourLife.html
37703770

@@ -3791,7 +3791,7 @@
37913791
title = {Ray Tracing: The Rest of Your Life},
37923792
author = {Peter Shirley, Trevor David Black, Steve Hollasch},
37933793
year = {2023},
3794-
month = {XXXXXXXX},
3794+
month = {August},
37953795
note = {\small \texttt{https://raytracing.github.io/books/RayTracingTheRestOfYourLife.html}},
37963796
url = {https://raytracing.github.io/books/RayTracingTheRestOfYourLife.html}
37973797
}
@@ -3807,7 +3807,7 @@
38073807
title = {Ray Tracing: The Rest of Your Life},
38083808
author = {Peter Shirley, Trevor David Black, Steve Hollasch},
38093809
year = {2023},
3810-
month = {XXXXXXXX},
3810+
month = {August},
38113811
url = {https://raytracing.github.io/books/RayTracingTheRestOfYourLife.html}
38123812
}
38133813
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

‎index.html‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,19 @@ <h1 class="title">Ray Tracing in One Weekend<br>—<br>The Book Series</h1>
2424
</div>
2525

2626

27+
<h1 class='alert' id='alpha'>Version 4.0.0-alpha.1</h1>
28+
29+
<p>The v4.0.0-alpha.1 release, announced for SIGGRAPH 2023, is now available for public consumption, and succeeds our
30+
now three-year-old v3.2.3 version, released December 2020. We've saved up this release for many significant updates to
31+
the book series, and are now recommending that readers use this version if possible. For a summary of changes, see
32+
<a href="https://github.com/RayTracing/raytracing.github.io/blob/master/CHANGELOG.md">the CHANGELOG</a>. Please
33+
log all issues and suggestions <a href="https://github.com/RayTracing/raytracing.github.io/issues">on the GitHub
34+
issues page</a> for our project.
35+
36+
<p>If you still wish to use v3.2.3 until the final v4 release, you can find it <a href="v3/index.html">in the v3/
37+
directory</a> until we ship the v4.0.0 final version.
38+
39+
2740
<h1 id='books'>Getting the Books</h1>
2841

2942
<p>The <cite>Ray Tracing in One Weekend</cite> series of books are now available to the public for free online. They

‎style/website.css‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ body {
22
margin: 3em 8%;
33
font-family: Helvetica, Arial, sans-serif;
44
color: black;
5-
background: #f0eeec;
5+
background-color: #f0eeec;
66
}
77

88
a {
@@ -23,15 +23,20 @@ div.content {
2323
margin: 0 auto;
2424
}
2525

26-
h1, h2, h3 {
26+
h1, h2, h3, .banner {
2727
font-family: Copperplate Gothic, Georgia, serif;
2828
}
2929

30+
h1.alert
31+
{
32+
background-color: #702000;
33+
}
34+
3035
h1 {
3136
font-weight: 900;
3237
margin: 1.5em 0 0 0;
3338
padding-left: 1ex;
34-
background: #2c2c2c;
39+
background-color: #2c2c2c;
3540
color: white;
3641
}
3742

0 commit comments

Comments
 (0)