Merge branch 'main' of github.com:flatironinstitute/sciware

README.md

@@ -29,3 +29,12 @@ A developing series of meetings about software development for science.
 - Sep 29, 2022 [Types](24_Types): An theoretical introduction to how thinking about data types can improve code, and specific applications to mypy
 - Oct 20, 2022 [Modern C++](25_ModernC++)
 - Dec 15, 2022 [File Formats and Storing Data](26_DataFormats)
+
+# Homepage Build Script
+
+A simple Node script — [build-index-page.mjs](build-index-page.mjs) is used to render `index.html`. The Node script does not have any external dependencies, so you don't need to `npm install`:
+
+```bash
+module load nodejs
+node build-index-page.mjs
+```

build-index-page.mjs

@@ -8,6 +8,8 @@
 import fs from "node:fs";
 import { execSync } from "node:child_process";
 
+// Add events here to have them appear at the top of the page.
+// If this array is empty, the page will display a message saying there are no upcoming events.
 const upcoming_events = [
   // {
   //   title: `Tool Setup, Intro to the Shell and the Cluster`,
@@ -77,6 +79,9 @@ const upcoming_events = [
   },
 ];
 
+// This is an array of past events, with the format:
+// [session number, title, date, slides link, github link, vimeo link]
+// The array is reversed so that the most recent events appear first.
 const past_events = [
   [`Session #00`, `Founding`, `Feb 28, 2019`, `/00_Founding/slides.html`, `https://github.com/flatironinstitute/sciware/tree/main/00_Founding`],
   [`Session #01`, `Overview`, `Mar 28, 2019`, `/01_Overview/reveal.html`, `https://github.com/flatironinstitute/sciware/tree/main/01_Overview`],