Skip to content

Commit 11f4d72

Browse files
committed
Project file updates for v4.0.0
1 parent ff66766 commit 11f4d72

File tree

4 files changed

+27
-46
lines changed

4 files changed

+27
-46
lines changed

Diff for: CONTRIBUTING.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,21 @@ improvements.
1313
Development Branches
1414
---------------------
1515
We use `release` as our release branch. _Generally, changes should never go directly to the release
16-
branch_. All ongoing development work (and all of the latest changes) will be in the `dev` branch.
17-
However, we may want changes in other development branches (for example, in a `dev-patch` branch for
18-
a quick patch release). The appropriate target branch for any pull requests you want to make will be
19-
determined in the associated issue first (all pull requests should have an associated issue).
16+
branch_. All ongoing development work (and all of the latest changes) will be in the `dev-patch`,
17+
`dev-minor`, `dev-major`, or feature branches. The appropriate target branch for any pull requests
18+
you want to make will be determined in the associated issue first (all pull requests should have an
19+
associated issue).
2020

2121

2222
Issues
2323
-------
2424
The easiest way to help out is to log any issues you find in the books. Unclear passages, errors of
2525
all kinds, even better ways to present something -- just go to the [issues page][].
2626

27-
1. First ensure that the issue is still outstanding in the current development branch (`dev`). Often
28-
the issue has already been addressed or no longer applies to the latest in-development version.
27+
1. First ensure that the issue is still outstanding (check `dev-patch`, `dev-minor` or `dev-major`
28+
as appropriate). Often the issue has already been addressed or no longer applies to the latest
29+
in-development version. Admittedly, that's a bit of a hassle, but at least step two should help
30+
you avoid duplicate issues.
2931

3032
2. **Before creating a new issue**, please review existing issues to see if someone has already
3133
submitted the same one. Chances are you're not the first to encounter something, so a little
@@ -55,7 +57,7 @@ To contribute a change to the project, *please follow these steps*:
5557
for the release type and release schedule.
5658

5759
4. Once you've received instructions to proceed with your change, create a new feature branch (or
58-
fork) from the assigned development branch (usually `dev`).
60+
fork) from the assigned development branch (usually `dev-patch`, `dev-minor`, or `dev-major`).
5961

6062
5. Follow the existing code style.
6163

@@ -82,7 +84,7 @@ To contribute a change to the project, *please follow these steps*:
8284
[issue #1262](https://github.com/RayTracing/raytracing.github.io/issues/1262) and
8385
[PR #1263](https://github.com/RayTracing/raytracing.github.io/pull/1263).
8486

85-
7. When ready, create your pull request (PR) and request a review from "rt-reviewers".
87+
7. When ready, create your pull request (PR) and request a review from "RayTracing/reviewers".
8688

8789
8. Congratulate yourself for having been part of the 1% of contributors who actually read and
8890
followed these guidelines.

Diff for: PRINTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ may be a fix in the works for this.
1313

1414
Pre-Printed Books
1515
------------------
16-
I've gone back and created PDFs for each book for versions v2.0.0, v3.0.0, v3.2.3. You can find
16+
I've gone back and created PDFs for each book for versions since v2.0.0. You can find
1717
these in the assets section of each release on the [GitHub releases page][releases]. We will include
1818
PDFs for all books with all future releases.
1919

Diff for: README.md

+12-23
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Getting the Books
1111
The _Ray Tracing in One Weekend_ series of books are now available to the public for free directly
1212
from the web.
1313

14-
### Version 4.0.0-alpha.2
14+
### Version 4.0.0
1515

1616
- [Ray Tracing in One Weekend][web1]
1717
- [Ray Tracing: The Next Week][web2]
@@ -29,20 +29,12 @@ first**_.
2929

3030
Project Status
3131
---------------
32-
Ok, v4.0.0-alpha.2 is finally out the door, and we are now heads down on getting the final v4.0.0
33-
version complete and shipped by SIGGRAPH 2024, July 28. At present, that means we are largely
34-
focused on _Ray Tracing: The Rest of Your Life_ — the third book in the series.
32+
v4.0.0 has shipped! Three and a half years in the making, with massive changes to all three books
33+
and accompanying code.
3534

36-
**v4.0.0-alpha.2 is released.** Books one and two are largely complete, and we're now focusing on
37-
book three. You can find it at the regular spot: https://raytracing.github.io. We are temporarily
38-
preserving the final version of v3.2.3 inside the repo, so you can just grab the latest and
39-
reference both versions.
40-
41-
If you'd like to check out the latest updates and watch our progress, we're on the `dev` branch. You
42-
can also browse our release backlog to see what we're planning. Our relevant milestones are
43-
44-
- [v4.0.0](https://github.com/RayTracing/raytracing.github.io/milestone/16)
45-
- [v4.0.0-release](https://github.com/RayTracing/raytracing.github.io/milestone/19)
35+
If you'd like to check out the latest updates and watch our progress, we're on the `dev-patch`,
36+
`dev-minor`, and `dev-major` branches. You can also browse our release backlog to see what we're
37+
planning.
4638

4739
If you're interested in contributing, email us! You can find our contact info at the head of each
4840
book. Or just start [a new discussion][discussions] or [issue][issues].
@@ -95,15 +87,15 @@ represent ideal (or optimized) C++ code.
9587

9688
### Implementations in Other Languages
9789
The _Ray Tracing in One Weekend_ series has a long history of implementations in other programming
98-
languages (see [_Implementations in Other Languages_][implementations]), and across different
90+
languages (see [Implementations in Other Languages][implementations]), and across different
9991
operating systems. Feel free to add your own implementation to the list!
10092

10193
### Branches
102-
In general, ongoing development, with all of the latest changes, can be found in the `dev` branch,
103-
which may contain patch, minor and major changes, depending on the release in progress. We try to
104-
keep CHANGELOG.md up to date, so you can easily browse what's new in each development branch. We may
105-
from time to time use additional development branches, so stay up to date by reviewing the
106-
[CONTRIBUTING][] page.
94+
In general, ongoing development, with all of the latest changes, can be found in the `dev-patch`,
95+
`dev-minor`, and `dev-major` branches, minor and major changes, depending on the change level and
96+
release in progress. We try to keep CHANGELOG.md up to date, so you can easily browse what's new in
97+
each development branch. We may from time to time use additional development branches, so stay up to
98+
date by reviewing the [CONTRIBUTING][] page.
10799

108100
The `release` branch contains the latest released (and live) assets. This is the branch from which
109101
GitHub pages serves up https://raytracing.github.io/.
@@ -211,10 +203,7 @@ _**please review the [CONTRIBUTING][] document for the most effective way to pro
211203
[ImageMagick]: https://imagemagick.org/
212204
[implementations]: https://github.com/RayTracing/raytracing.github.io/wiki/Implementations
213205
[issues]: https://github.com/RayTracing/raytracing.github.io/issues/
214-
[milestone 16]: https://github.com/RayTracing/raytracing.github.io/milestone/16
215-
[milestone 19]: https://github.com/RayTracing/raytracing.github.io/milestone/19
216206
[PRINTING.md]: PRINTING.md
217-
[v3.2.3]: https://github.com/RayTracing/raytracing.github.io/releases/tag/v3.2.3
218207
[web1]: https://raytracing.github.io/books/RayTracingInOneWeekend.html
219208
[web2]: https://raytracing.github.io/books/RayTracingTheNextWeek.html
220209
[web3]: https://raytracing.github.io/books/RayTracingTheRestOfYourLife.html

Diff for: index.html

+4-14
Original file line numberDiff line numberDiff line change
@@ -24,20 +24,10 @@ <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.2</h1>
28-
29-
<p>The v4.0.0-alpha.2 release is the second and planned last alpha release of the book series. While the primary focus
30-
of this release has been updates to <cite>Ray Tracing: The Next Week</cite>, the alpha releases have significant
31-
updates across all three books. We recommend that readers use this version over the old v3.2.3 version. For a summary
32-
of changes, see <a href="https://github.com/RayTracing/raytracing.github.io/blob/master/CHANGELOG.md">the
33-
CHANGELOG</a>. We are currently planning to release the final v4.0.0 version by SIGGRAPH 2024, July 28. Please log all
34-
issues and suggestions <a href="https://github.com/RayTracing/raytracing.github.io/issues">on the GitHub issues
35-
page</a> for our project.
36-
3727
<h1 id='books'>Getting the Books</h1>
3828

3929
<p>The <cite>Ray Tracing in One Weekend</cite> series of books are now available to the public for free online. They
40-
are now released under <a href="https://github.com/RayTracing/raytracing.github.io/blob/master/COPYING.txt">the CC0
30+
are now released under <a href="https://github.com/RayTracing/raytracing.github.io/blob/release/COPYING.txt">the CC0
4131
license</a>. This means that they are as close to public domain as we can get. (While that also frees you from the
4232
requirement of providing attribution, it would help the overall project if you could point back to this web site as a
4333
service to other users.)
@@ -73,8 +63,8 @@ <h1 id='source'>Source Code</h1>
7363
<a href="https://github.com/RayTracing/raytracing.github.io">https://github.com/RayTracing/raytracing.github.io</a>.
7464
You can also directly download the latest version of the entire project (all three books) as a single archive file:
7565
<ul>
76-
<li><a href="https://github.com/RayTracing/raytracing.github.io/archive/master.zip">.ZIP format</a>
77-
<li><a href="https://github.com/RayTracing/raytracing.github.io/archive/master.tar.gz">.tar.gz format</a>
66+
<li><a href="https://github.com/RayTracing/raytracing.github.io/archive/release.zip">.ZIP format</a>
67+
<li><a href="https://github.com/RayTracing/raytracing.github.io/archive/release.tar.gz">.tar.gz format</a>
7868
</ul>
7969

8070

@@ -90,7 +80,7 @@ <h1 id='issues'>Issues</h1>
9080

9181
<h1 id='contributing'>Contributing</h1>
9282
<p>Interested in helping out? Please read the guidelines in the
93-
<a href="https://github.com/RayTracing/raytracing.github.io/blob/master/CONTRIBUTING.md">CONTRIBUTING.md</a> document
83+
<a href="https://github.com/RayTracing/raytracing.github.io/blob/release/CONTRIBUTING.md">CONTRIBUTING.md</a> document
9484
first. <em>Pull requests without associated issues, or submitted without coordination, are highly likely to be
9585
rejected.</em>
9686

0 commit comments

Comments
 (0)