Skip to content

Commit 7f5c1b7

Browse files
author
Trevor Black
committed
2/3 done with CHANGELOG first pass. #20 
1 parent 71fdcf2 commit 7f5c1b7

File tree

1 file changed

+131
-30
lines changed

1 file changed

+131
-30
lines changed

‎CHANGELOG.md

Lines changed: 131 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,46 +2,147 @@ Change Log
22
================================================================================
33

44
v2.0.0 (In Progress)
5-
-------------------
6-
### Major Changes
7-
- Created single monolithic raytracing.github.io repo
8-
- Moved existing _InOneWeekend_, _TheNextWeek_, _TheRestOfYourLife_ content to io repo
9-
- Deprecated existing _InOneWeekend_, _TheNextWeek_, _TheRestOfYourLife_ repos
10-
- Fixed chapter order in _Ray Tracing: The Rest Of Your Life_
11-
- Typo in chapter numbering lead to two chapter 2s
12-
- All proceeding chapters were off by one
13-
- Corrected second instance of chapter 2 as chapter 3
14-
- Proceeding chapters were incremented as fix
15-
16-
### Minor Changes
17-
- Added CHANGELOG.md
18-
- Added CONTRIBUTING.md
19-
- Added COPYING.txt
20-
- Created COPYING.md
21-
- Changed license to CC0 in COPYING.md
22-
- Renamed COPYING.md to COPYING.txt
23-
24-
### Patches
25-
- Removed bug in Chapter 2 of _Ray Tracing: The Rest Of Your life_
26-
- The `lambertian` class definition in Chapter 2 previously used `texture`s
27-
- This has been changed to `vec3`
28-
- Replaced drand48() with portable random number generation across all three books
5+
---------------------
6+
Common
7+
- Add: Created single monolithic raytracing.github.io repo
8+
- Change: Deprecated existing _InOneWeekend_, _TheNextWeek_, _TheRestOfYourLife_ repos
9+
- Change: Moved existing _InOneWeekend_, _TheNextWeek_, _TheRestOfYourLife_ content to io repo
10+
- Add: CHANGELOG.md
11+
- Add: CONTRIBUTING.md
12+
- Add: COPYING.txt
13+
- Add: README.md
14+
- Change: License change to CC0 in COPYING.txt
15+
- Add: Markdeep documents created for all three
16+
- Change: Replaced drand48() with portable random number generation
17+
- Add: raytracing.github.io links to all the three books
18+
- Change: Web links have been changed to new locations
19+
- Add: Links to Kindle version of the books
20+
- Add: Syntax coloring for highlighting of text in source blocks
21+
- Add: CSS for images
22+
- Add: CSS for body of the text
23+
- Add: CSS for code blocks
24+
- Add: CSS for the Print variant of the books
25+
26+
_Ray Tracing In One Weekend_
27+
- Add: README.md
28+
- Add: Source README.md
29+
- Add: Markdeep page created for entire body of text
30+
- Add: Markdeep MathJax created for formulae and equations for body of text
31+
- Add: raytracing.github.io/books/RayTracingInOneWeekend.html
32+
- Change: Text, Syntax highlighting of source modifications
33+
- Change: Text, Chapter 2, Reorder include files in code blocks to match src conventions
34+
- Change: Text, Chapter 2, Consistent use of spaces in code blocks
35+
- Change: Text, Chapter 2, Reordered `vec3` class functions to + - * /
36+
- Change: Text, Chapter 2, unbolded unit_vector
37+
- Change: Text, Chapter 3, Reorder include files in code blocks to match src conventions
38+
- Change: Text, Chapter 3, Remove `*world` and `depth` parameters from `color` function signature
39+
- Change: Text, Chapter 5, Reorder include files in code blocks to match src conventions
40+
- Change: Text, Chapter 5, Consistent use of spaces in code blocks
41+
- Change: Text, Chapter 5, Put `hit_record` and `{` on the same line
42+
- Change: Text, Chapter 6, Consistent use of spaces in code blocks
43+
- Change: Text, Chapter 6, Add `#include "random.h"` in code blocks
44+
- Change: Text, Chapter 7, Remove `depth` parameter from `color` function signature
45+
- Change: Text, Chapter 8, Consistent use of spaces in code blocks
46+
- Change: Text, Chapter 8, Put function signatures and `{` on the same line
47+
- Change: Text, Chapter 9, Consistent use of spaces in code blocks
48+
- Change: Text, Chapter 9, Put function signatures and `{` on the same line
49+
- Change: Text, Chapter 9, Changed contents of `List[0]` to match original text
50+
- Change: Text, Chapter 10, Consistent use of spaces in code blocks
51+
- Change: Text, Chapter 10, Add curly braces for `if (refract)` statement
52+
- Change: Text, Chapter 10, Remove `0.0` from metal instantiation
53+
- Change: Text, Chapter 11, Change `lookatfrom` to `lookfrom`
54+
- Change: Text, Chapter 12, Put function signatures and `{` on the same line
55+
56+
57+
_Ray Tracing: The Next Week_
58+
- Add: README.md
59+
- Add: Source README.md
60+
- Add: Markdeep page created for entire body of text
61+
- Add: Markdeep MathJax created for formulae and equations for body of text
62+
- Add: raytracing.github.io/books/RayTracingTheNextWeek.html
63+
- Change: Text, Syntax highlighting of source modifications
64+
- Change: Text, Chapter 2, Consistent use of spaces in code blocks
65+
- Change: Text, Chapter 2, Rewrote `Camera` constructors parameters to match _In One Weekend_
66+
- Change: Text, Chapter 3, Consistent use of spaces in code blocks
67+
- Change: Text, Chapter 4, Consistent use of spaces in code blocks
68+
- Change: Text, Chapter 4, Changed open brace to curly in `constant_texture` constructor
69+
- Change: Text, Chapter 4, Changed open brace to curly at `const (`
70+
- Change: Text, Chapter 4, Added `;` to `List[0]` and `List[1]`
71+
- Change: Text, Chapter 5, Consistent use of spaces in code blocks
72+
- Change: Text, Chapter 5, added "texture" to "We can use that texture on some spheres"
73+
- Change: Text, Chapter 5, Changed open brace to curly in `two_perlin_sphere` signature
74+
- Change: Text, Chapter 5, Changed `Z` to `2` in `trilinear_interp` signature
75+
- Change: Text, Chapter 5, Removed `;` from `pexm_z` index
76+
- Change: Text, Chapter 7, Consistent use of spaces in code blocks
77+
- Change: Text, Chapter 7, "This is yz and xz" changed to "This is xz and yz"
78+
- Change: Text, Chapter 7, Changed `cornell_box` hittable array size to 5
79+
- Change: Text, Chapter 8, Changed "And the changes to Cornell is" to "... Cornell are"
80+
- Change: Text, Chapter 9, Changed short if statements to two lines for Consistency
81+
- Change: Text, Chapter 10, Consistent use of spaces in code blocks
82+
- Change: Code and Text, Chapter 8, cleaned up implementation of `constant_medium::hit`
83+
- Change: Code and Text, Chapter 8, Rewrote debug functionality in `constant_medium::hit`
84+
85+
86+
_Ray Tracing: The Rest Of Your Life_
87+
- Add: README.md
88+
- Add: Source README.md
89+
- Add: Markdeep page created for entire body of text
90+
- Add: Markdeep MathJax created for formulae and equations for body of text
91+
- Add: raytracing.github.io/books/RayTracingTheRestOfYourLife.html
92+
- Fix: Text, Chapter order starting from chapter 2
93+
- Fix: Text, Renamed figures and images to match new chapter numbering
94+
- Fix: Text, Chapter 2, The `lambertian` class definition now uses `vec3` instead of `texture`s.
95+
- Change: Text, Syntax highlighting of source modifications
96+
- Change: Text, Chapter 2, Reorder include files in code blocks to match src conventions
97+
- Change: Text, Chapter 2, Changed `i < NX` to `i < N`
98+
- Change: Text, Chapter 3, Reorder include files in code blocks to match src conventions
99+
- Change: Text, Chapter 6, Consistent use of spaces in code blocks
100+
- Change: Text, Chapter 6, Remove `flip_normals` from code block
101+
- Change: Text, Chapter 6, Consistent use of spaces in code blocks
102+
- Change: Text, Chapter 6, Change `hrec` to `rec`
103+
- Change: Text, Chapter 8, Changed calculation of `a` axis to pseudocode
104+
- Change: Text, Chapter 8, Consistent use of spaces in code blocks
105+
- Fix: Code and Text, Chapter 6, removal of factor of 2 to `random_cosine_direction` calculation
106+
- Fix: Text, Chapter 4, Rewrote formula for "Color" to "Color = A * color(direction"
107+
108+
29109

30110

31111
v1.123.0 (2018-08-26)
32112
-----------------------
33-
### Minor Changes
34-
- First GitHub release of _Ray Tracing: The Rest Of Your Life_, bundled with source code.
113+
_Ray Tracing: The Rest Of Your Life_
114+
- Add: First GitHub release.
35115

36116

37117
v1.54.0 (2018-08-26)
38118
----------------------
39-
### Minor Changes
40-
- First GitHub release of _Ray Tracing In One Weekend_, bundled with source code.
119+
_Ray Tracing In One Weekend_
120+
- Add: First GitHub release.
41121

42122

43123
v1.42.0 (2018-08-26)
44124
----------------------
45-
### Minor Changes
46-
- First GitHub release of _Ray Tracing: The Next Week_, bundled with source code.
125+
_Ray Tracing: The Next Week_
126+
- Add: First GitHub release.
127+
128+
129+
# TODO:
130+
- [ ] Go through closed (and open) issues
131+
- [ ] Go through repo contents
132+
- [ ] Check for bug that I found, and changed for clarity
133+
- [ ] Check changes against original text
134+
- [ ] Formatting changes
135+
- [ ] Fix line width
136+
- [ ] git push
137+
138+
# Comments:
139+
- feel free to condense/elaborate/combine some of the change notes
140+
- Lots of the codeblock changes can probably be combined at the text level
141+
- Formatting comments are _encouraged_
142+
- It's hard to tell which sanity changes were from transcription mistakes vs original errors
143+
- from code_block sanity check _InOneWeekend_ has chapters 8,9,10,11 incorrectly labelled
47144

145+
# Issues
146+
- None of the _Sanity pass for Code Blocks_ changes ported to the src
147+
- if (refract) in chapter 10 of _InOneWeekend_ needs curly braces
148+
- In chapter 7 of _RestOfYourLife_ z calculation is different

0 commit comments

Comments
 (0)