@@ -5,35 +5,36 @@ The _Ray Tracing in One Weekend_ series is intended to be lightweight and access
55want to learn about ray tracing and related graphics topics. To that end, we welcome feedback,
66proposals, and improvements.
77
8- In particular, we have recently moved to a dedicated GitHub organization, and are working hard to
9- get set up in the new location. On top of this, we're converting the books (already freely available
10- to the public) to HTML, so that we can keep the content up-to-date with the latest corrections and
8+ In particular, we are now a dedicated GitHub organization. The books are now available in HTML from
9+ https://raytracing.github.io/ , so we can keep the content up-to-date with the latest corrections and
1110improvements.
1211
13- If you're interested in helping out, there are a number of ways you could help us. The most pressing
14- right now is converting the books to [ Markdeep] [ ] , a great Markdown-like format with lots of extra
15- goodies (like mathematical equations and diagrams).
1612
17- Here are other ways you can help improve these books.
13+ Repository Organization
14+ ------------------------
15+ This repository has the following organization
1816
19-
20- Project Homes
21- --------------
22- All books reside in their own directory in the ` raytracing.github.io ` repository.
23-
24- - [ _ Ray Tracing in One Weekend_ ] [ ]
25- - [ _ Ray Tracing: The Next Week_ ] [ ]
26- - [ _ Ray Tracing: The Rest of Your Life_ ] [ ]
17+ ``` bash
18+ raytracing.github.io/ # Repository root
19+ books/ # Book content
20+ images/ # All figures, renderings and other images used throughout the project
21+ src/ # Source code
22+ common/ # Source code that is common to two or more books
23+ InOneWeekend/ # The final form of source code for Ray Tracing In One Weekend
24+ TheNextWeek/ # The final form of source code for Ray Tracing: The Next Week
25+ TheRestOfYourLife/ # The final form of source code for Ray Tracing: The Rest Of Your Life
26+ style/ # CSS for books and web site
27+ ```
2728
2829
2930Issues
3031-------
3132The easiest way to help out is to log any issues you find in the books. Unclear passages, errors of
3233all kinds, even better ways to present something -- just go to the [ issues page] [ ] .
3334
34- _ Before creating a new issue _ , please review existing issues to see if someone has already submitted
35- the same one. Odds are you're not the first to encounter something, so a little quick research can
36- save everyone some hassle.
35+ ** Before creating a new issue ** , please review existing issues to see if someone has already
36+ submitted the same one. Odds are you're not the first to encounter something, so a little quick
37+ research can save everyone some hassle.
3738
3839When entering a new issue, please include all relevant information. For content issues, include the
3940book or books this applies to, and specific locations that should be reviewed. Similarly for code:
@@ -44,8 +45,9 @@ Pull Requests
4445--------------
4546If you have a change that you think would be worthwhile, start with creating an issue, and indicate
4647whether you're willing to submit the change yourself. We'll let you know if it sounds like a good
47- idea. If so, create your own fork of the project, make the changes, and then create a standard
48- GitHub pull request for us to review.
48+ idea, whether it duplicates another issue or work already planned. If you get the green light,
49+ create your own fork of the project, make the changes, and then create a standard GitHub pull
50+ request for us to review.
4951
5052New to GitHub? We'll walk you through the process above. Just mention that you'd like a little
5153guidance in the proposal issue.
@@ -57,8 +59,4 @@ If you have any questions, feel free to ping me at
[email protected] .
5759
5860
5961
60- [ issues page ] : https://github.com/RayTracing/raytracing.github.io/issues/
61- [ Markdeep ] : https://casual-effects.com/markdeep
62- [ _Ray Tracing in One Weekend_ ] : https://github.com/RayTracing/raytracing.github.io/tree/master/InOneWeekend
63- [ _Ray Tracing: The Next Week_ ] : https://github.com/RayTracing/raytracing.github.io/tree/master/TheNextWeek
64- [ _Ray Tracing: The Rest of Your Life_ ] : https://github.com/RayTracing/raytracing.github.io/tree/master/TheRestOfYourLife
62+ [ issues page ] : https://github.com/RayTracing/raytracing.github.io/issues/
0 commit comments