Skip to content

Commit 7971411

Browse files
trevordblackhollasch
authored andcommitted
Added a source README to the 3 src folders
1 parent 553bac0 commit 7971411

File tree

3 files changed

+111
-0
lines changed

3 files changed

+111
-0
lines changed

src/InOneWeekend/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
Ray Tracing in One Weekend - Source
2+
====================================================================================================
3+
4+
Content
5+
--------
6+
This folder ([InOneWeekend][]) contains the finished code of the [_Ray Tracing in One Weekend_][] book.
7+
8+
Intent
9+
-------
10+
This folder is not meant to act as it's own tutorial. The source presented here is provided so that you can compare your work when going along with the book. We strongly recommend reading and following along with the book if you want to understand the source.
11+
12+
Programming Language
13+
---------------------
14+
This book is written in c++ with some modern features of c++11. The code as written is designed to be readable by the largest collection of potential programmers. The code is not meant to illustrate idealized c++ code.
15+
16+
Building
17+
---------
18+
No mechanism for building is included with this project.
19+
20+
The _Ray Tracing in One Weekend_ series has a long history of being written in other programming languages ([Implementations in Other Languages][]) and across all three primary operating systems.
21+
22+
It is necessary for you to create your own build tooling. However, the source begins as a single main file and builds to only a small collection of additional header files.
23+
24+
The c++ code as written should compile across all three platforms (Win, OSX, Linux).
25+
26+
Corrections & Contributions
27+
----------------------------
28+
If you spot errors, have suggested corrections, or would like to help out with the project, please
29+
review the [CONTRIBUTING][] document for the most effective way to proceed.
30+
31+
32+
33+
[InOneWeekend]: https://github.com/RayTracing/raytracing.github.io/tree/master/src/InOneWeekend
34+
[_Ray Tracing in One Weekend_]: https://github.com/RayTracing/raytracing.github.io/tree/master/books/RayTracingInOneWeekend.html
35+
[Implementations in Other Languages]: https://github.com/RayTracing/InOneWeekend/wiki/Implementations-in-Other-Languages
36+
[CONTRIBUTING]: ../../CONTRIBUTING.md

src/TheNextWeek/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Ray Tracing: The Next Week - Source
2+
====================================================================================================
3+
4+
Content
5+
--------
6+
This folder ([TheNextWeek][]) contains the finished code of the [_Ray Tracing: The Next Week_][] book.
7+
8+
Every chapter of [_Ray Tracing: The Next Week_][] acts as it's own mini tutorial, and each chapter is largely independent of other chapters. Every chapter ends with an example render, and in the source, the [main.cc][] contains a render function specific to each chapter. The source presented here represents the simplest superset of the code from all chapters.
9+
10+
Intent
11+
-------
12+
This folder is not meant to act as it's own tutorial. The source presented here is provided so that you can compare your work when going along with the book. We strongly recommend reading and following along with the book if you want to understand the source.
13+
14+
Programming Language
15+
---------------------
16+
This book is written in c++ with some modern features of c++11. The code as written is designed to be readable by the largest collection of potential programmers. The code is not meant to illustrate idealized c++ code.
17+
18+
Building
19+
---------
20+
No mechanism for building is included with this project.
21+
22+
The _Ray Tracing in One Weekend_ series has a long history of being written in other programming languages ([Implementations in Other Languages][]) and across all three primary operating systems.
23+
24+
It is necessary for you to create your own build tooling. However, the source begins as a single main file and builds to only a small collection of additional header files.
25+
26+
The c++ code as written should compile across all three platforms (Win, OSX, Linux).
27+
28+
Corrections & Contributions
29+
----------------------------
30+
If you spot errors, have suggested corrections, or would like to help out with the project, please
31+
review the [CONTRIBUTING][] document for the most effective way to proceed.
32+
33+
34+
35+
[TheNextWeek]: https://github.com/RayTracing/raytracing.github.io/tree/master/src/TheNextWeek
36+
[_Ray Tracing: The Next Week_]: https://github.com/RayTracing/raytracing.github.io/tree/master/books/RayTracingTheNextWeek.html
37+
[main.cc]: https://github.com/RayTracing/raytracing.github.io/tree/master/src/TheNextWeek/main.cc
38+
[Implementations in Other Languages]: https://github.com/RayTracing/InOneWeekend/wiki/Implementations-in-Other-Languages
39+
[CONTRIBUTING]: ../../CONTRIBUTING.md

src/TheRestOfYourLife/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
Ray Tracing: The Rest Of Your Life - Source
2+
====================================================================================================
3+
4+
Content
5+
--------
6+
This folder ([TheRestOfYourLife][]) contains the finished code of the [_Ray Tracing: The Rest Of Your Life_][] book.
7+
8+
Intent
9+
-------
10+
This folder is not meant to act as it's own tutorial. The source presented here is provided so that you can compare your work when going along with the book. We strongly recommend reading and following along with the book if you want to understand the source.
11+
12+
Programming Language
13+
---------------------
14+
This book is written in c++ with some modern features of c++11. The code as written is designed to be readable by the largest collection of potential programmers. The code is not meant to illustrate idealized c++ code.
15+
16+
Building
17+
---------
18+
No mechanism for building is included with this project.
19+
20+
The _Ray Tracing in One Weekend_ series has a long history of being written in other programming languages ([Implementations in Other Languages][]) and across all three primary operating systems.
21+
22+
It is necessary for you to create your own build tooling. However, the source begins as a single main file and builds to only a small collection of additional header files.
23+
24+
The c++ code as written should compile across all three platforms (Win, OSX, Linux).
25+
26+
Corrections & Contributions
27+
----------------------------
28+
If you spot errors, have suggested corrections, or would like to help out with the project, please
29+
review the [CONTRIBUTING][] document for the most effective way to proceed.
30+
31+
32+
33+
[TheRestOfYourLife]: https://github.com/RayTracing/raytracing.github.io/tree/master/src/TheRestOfYourLife
34+
[_Ray Tracing: The Next Week_]: https://github.com/RayTracing/raytracing.github.io/tree/master/books/RayTracingTheRestOfYourLife.html
35+
[Implementations in Other Languages]: https://github.com/RayTracing/InOneWeekend/wiki/Implementations-in-Other-Languages
36+
[CONTRIBUTING]: ../../CONTRIBUTING.md

0 commit comments

Comments
 (0)