summaryrefslogtreecommitdiff
path: root/guide-src/development/index.html
diff options
context:
space:
mode:
Diffstat (limited to 'guide-src/development/index.html')
-rw-r--r--guide-src/development/index.html7
1 files changed, 6 insertions, 1 deletions
diff --git a/guide-src/development/index.html b/guide-src/development/index.html
index 717ff6d..c9a75d2 100644
--- a/guide-src/development/index.html
+++ b/guide-src/development/index.html
@@ -18,10 +18,15 @@ the main files of interest are <code>index.html</code> and <code>pugl.js</code>,
the JavaScript for pugl (hopefully it doesn't become too unmanageable to have just one file).
</p>
+<p>
+you can run <code>make</code> to generate a <code>public/</code> directory which has just the files
+that should be hosted.
+</p>
+
<h3>contributing to the guide</h3>
<p>
the guide is automatically generated from the files in <code>guide-src/</code> by <code>guide-src/make.py</code>
(you can also just run <code>make</code> to generate it), which is a simple script whose main purpose is adding
-a sidebar to all of the guide pages. any PNG files are automatically copied from <code>guide-src/</code> to <code>guide/</code>.
+a sidebar to all of the guide pages. any PNG/JPG/SVG files are automatically copied from <code>guide-src/</code> to <code>guide/</code>.
when you add or remove pages from the guide, you'll need to edit <code>guide-src/outline.txt</code>.
</p>