Skip to content

Commit 108eae7

Browse files
committed
update readme
1 parent 9c6db94 commit 108eae7

File tree

1 file changed

+28
-4
lines changed

1 file changed

+28
-4
lines changed

README.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,17 @@ This way you don't have to go back and fix already translated articles. Just tra
9292
at a time and leave the links as is. They'll link to placeholders until someone translates the missing
9393
articles.
9494

95+
**DO NOT CHANGE LINKS** : For example a link to a local resources might look like
96+
97+
[text](link)
98+
99+
or
100+
101+
<img src="somelink">
102+
103+
While you can add query parameters (see below) do not add "../" to try to make the link relative to the
104+
.md file. Links should stay as though the article exists at the same location as the original English.
105+
95106
### UI localization
96107

97108
Some of the diagrams allow passing translations for the UI and other text.
@@ -136,12 +147,27 @@ Steps
136147

137148
now open your browser to `http://localhost:8080`
138149

150+
#### Build options
151+
152+
This is mostly for debugging `build.js`. Since it takes a while to process all the files
153+
you can set `ARTICLE_FILTER` to a substring of the filenames to process. For example
154+
155+
ARTICLE_FILTER=rotation npm run build
156+
157+
Will build the site as though only articles with `rotation` in their filename exist.
158+
139159
## TO DO
140160

141-
A list of articles I'd like to write or see written
161+
* Make a continuous build
162+
163+
Right now the build processes all files at once. Part if this is because
164+
it builds RSS feeds and checks for missing files. If those are separated
165+
out then could make it continously build individual articles which would
166+
be super useful.
167+
168+
### A list of articles I'd like to write or see written
142169

143170
* lighting
144-
* spot lighting
145171
* normal maps
146172
* shadow maps
147173
* geometry
@@ -156,7 +182,6 @@ A list of articles I'd like to write or see written
156182
* animation
157183
* blendshapes
158184
* hierarchical animation
159-
* skinning
160185
* debugging
161186
* debugging JS WebGL
162187
* example (https://goo.gl/8U5whT)
@@ -185,7 +210,6 @@ A list of articles I'd like to write or see written
185210
* text
186211
* glyph cache
187212
* post processing
188-
* how to render to a texture (scene on cube)
189213
* DOF
190214
* glow
191215
* light rays

0 commit comments

Comments
 (0)