Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Thomas Wilburn committed Jan 17, 2019
1 parent 5fb7ce4 commit fcd058d
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion readme.rst
Expand Up @@ -67,4 +67,15 @@ When moving graphics and templates over from the classic rig, there are three ch
- Scripts that are module-aware can be imported to a variable, such as ``var d3 = require("./lib/d3.min")``
- Scripts that relied on global scope, such as ``helpers.js``, will need their functions assigned to the window object (e.g., ``var classify = window.classify = ...``).

Since most classic dailygraphics already bundled their own JS libraries, you shouldn't need to worry about NPM for these.
Since most classic dailygraphics already bundled their own JS libraries, you shouldn't need to worry about NPM for these.

Other files
-----------

The template folder also contains a set of HTML files that are required for the rig to function, which we've broken out so that they can be customized for non-NPR newsrooms:

* copyedit.html - The copy-edit e-mail text
* embed.html - The embed code used to place the interactive into a CMS page
* link.html - The "direct link" (used at NPR for stories distributed via the API, such as in-appp views)

Currently, the rig doesn't check for these to exist on startup, so it may crash if they're missing. Make sure your template repo is up-to-date if you see them listed in the stack trace!

0 comments on commit fcd058d

Please sign in to comment.