Skip to content

Commit da75744

Browse files
committed
README: udpate for 2023-07-13
1 parent d8d2178 commit da75744

File tree

1 file changed

+29
-24
lines changed

1 file changed

+29
-24
lines changed

README.md

Lines changed: 29 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,18 @@ versions, use the print function in your browser.
2121

2222
Project Status
2323
---------------
24-
Well, our work on the v4.0.0 release is plodding along. Our last release, [v3.2.3][] was in December
25-
2020, and v4 keeps getting bigger and bigger. Lots of changes. If you'd like to check it out, we're
26-
developing on the `dev-major` branch. You can also follow along with our remaining work on
27-
[milestone 16][] (the main body of remaining work), and [milestone 19][] (release preparation
28-
tasks). We're tackling some larger refactorings to further simplify the code, address some large
29-
outstanding issues, and focus on more development and expansion of book 3: _Ray Tracing: The Rest of
30-
Your Life_.
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.
27+
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
30+
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)
3136

3237
Let us know if you'd like to help out. If you have a change you'd like to contribute,
3338
_**[please see our contribution guidelines][CONTRIBUTING]**_.
@@ -43,33 +48,33 @@ Directory Structure
4348
-------------------
4449
The organization of this repository is meant to be simple and self-evident at a glance:
4550

46-
### books/
47-
This folder contains the three raytracing books (in HTML), and some supporting material.
51+
- `books/`
52+
: This folder contains the three raytracing books (in HTML), and some supporting material.
4853

49-
### images/
50-
Contains all of the images and figures of the books. Can also be used to compare your results.
54+
- `images/`
55+
: Contains all of the images and figures of the books. Can also be used to compare your results.
5156

52-
### style/
53-
Contains the css for the books and the site.
57+
- `style/`
58+
: Contains the css for the books and the site.
5459

55-
### src/
56-
Contains the source.
60+
- `src/`
61+
: Contains the source.
5762

58-
### src/common/
59-
Contains any headers that are common to two or more books. This is also where external headers
60-
are stored.
63+
- `src/common/`
64+
: Contains any headers that are common to two or more books. This is also where external headers are
65+
stored.
6166

62-
### src/`<book>`/
63-
Contains the source specific to any one book. Their is no sharing of source outside of the common
64-
directory.
67+
- `src/<book>/`
68+
: Contains the source specific to any one book. There is no sharing of source outside of the
69+
common directory.
6570

6671

6772
Source Code
6873
-----------
6974
### Intent
7075
This repository is not meant to act as its own tutorial. The source is provided so you can compare
7176
your work when progressing through the book. We strongly recommend reading and following along with
72-
the book to understand the source. Ideally, you'll be developing your own implmentation as you go,
77+
the book to understand the source. Ideally, you'll be developing your own implementation as you go,
7378
in order to deeply understand how a raytracer works.
7479

7580
### Downloading The Source Code
@@ -96,7 +101,7 @@ branch.
96101

97102
Building and Running
98103
---------------------
99-
Copies of source are provided for you to check your work and compare against. If you wish to build
104+
Copies of the source are provided for you to check your work and compare against. If you wish to build
100105
the provided source, this project uses CMake. To build, go to the root of the project directory and
101106
run the following commands to create the debug version of every executable:
102107

@@ -118,7 +123,7 @@ You may choose to use the CMake GUI when building on windows.
118123
`C:\Users\Peter\raytracing.github.io`.
119124
3. Add the folder "build" within the location of the copied directory. For example,
120125
`C:\Users\Peter\raytracing.github.io\build`.
121-
4. For "Where to build the binaries", set this to the newly-created build directory.
126+
4. For "Where to build the binaries", set this to the newly-created "build" directory.
122127
5. Click "Configure".
123128
6. For "Specify the generator for this project", set this to your version of Visual Studio.
124129
7. Click "Done".

0 commit comments

Comments
 (0)