From aac969b0d7ba830f15734a430348c7727aac1d71 Mon Sep 17 00:00:00 2001 From: Steven Presti Date: Thu, 26 Oct 2023 13:16:46 -0400 Subject: [PATCH] README: add some development notes --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 543cdcd..2f2e03a 100644 --- a/README.md +++ b/README.md @@ -12,4 +12,19 @@ Steps to run the meeting Navigate to this week's meeting and follow the steps presented. -Working days: non-holiday weekdays. Relevant holidays are the national holidays of the USA, Western Europe, and India. \ No newline at end of file +Working days: non-holiday weekdays. Relevant holidays are the national holidays of the USA, Western Europe, and India. + + +# Development + +## Prerequisites +- install node package manger (npm) +- use npm to install typescript `npm install typescript --save-dev` + +## Dev Workflow +- Work against the `.ts` files to add your changes +- Compile them using `npm run bundle` which produces `.js` files +- Commit the `.ts` and `.js` files + +### Note +The action uses the `.js` files to run the action, and are found in the `dist directory. The `.ts` files are used for development purposes only. \ No newline at end of file