From f4cc8ce7a8712e2e840b0c120a3f86eadb665626 Mon Sep 17 00:00:00 2001
From: pommicket
+note: this section is only for people who want to contribute to pugl itself.
+
+after cloning the repository,
+make sure you run
+
+
+this ensures that your changes are prettified & linted.
+npm install
+ln -s ../../pre-commit .git/hooks/
+the main files of interest are index.html
and pugl.js
, which has all
+the JavaScript for pugl (hopefully it doesn't become too unmanageable to have just one file).
+
+the guide is automatically generated from the files in guide-src/
by guide-src/make.py
+(you can also just run make
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 guide-src/
to guide/
.
+when you add or remove pages from the guide, you'll need to edit guide-src/outline.txt
.
+
+pugl has no dependencies, and i'd like to keep it that way. +
+ ++i've been pretty liberal about using modern javascript; +even though this could in theory run on IE it doesn't +(in particular it's very nice to have template literals). +that said, try to only use features that have at least as much +support as webgl2 (i.e. >94%). +
+ ++we use webgl2 because: +