From 3cdd5fec331cf11350a95be73dd1326ffcb1c1ea Mon Sep 17 00:00:00 2001 From: Pomax Date: Mon, 14 Sep 2020 08:32:49 -0700 Subject: [PATCH 1/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1621475b..96d7db26 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # BezierInfo-2: a dev repository -This is the development repository for ["A Primer on Bézier Curves"](https://pomax.github.io.bezierinfo). +This is the development repository for ["A Primer on Bézier Curves"](https://pomax.github.io.bezierinfo), itself hosted as http://pomax.github.io/BezierInfo-2/ The primer is currently being rewritten from a React application to a pure HTML/CSS/Vanilla-JS tech stack. From 10d7c27bfd9b0e598720ed34e6241697611f05cc Mon Sep 17 00:00:00 2001 From: Pomax Date: Mon, 14 Sep 2020 08:35:01 -0700 Subject: [PATCH 2/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 96d7db26..949a4714 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # BezierInfo-2: a dev repository -This is the development repository for ["A Primer on Bézier Curves"](https://pomax.github.io.bezierinfo), itself hosted as http://pomax.github.io/BezierInfo-2/ +This is the development repository for ["A Primer on Bézier Curves"](https://pomax.github.io.bezierinfo), itself hosted as https://pomax.github.io/BezierInfo-2/ The primer is currently being rewritten from a React application to a pure HTML/CSS/Vanilla-JS tech stack. From e84b4b860ed95640704319b09b320fc6eb11802f Mon Sep 17 00:00:00 2001 From: Pomax Date: Mon, 14 Sep 2020 08:37:52 -0700 Subject: [PATCH 3/5] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 949a4714..f33ee548 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,8 @@ See https://github.com/Pomax/BezierInfo-2/issues/257 for the current rewrite sta ## Building everything +Use the latest Node v14, with all dependencies installed. Nnote that [node-canvas](https://github.com/Automattic/node-canva) has [special instructions](https://github.com/Automattic/node-canvas/wiki/Installation:-Windows) because it's going to have to compile itself (however, JPEG support is not needed for this project). + - The general single-build-pass command is simply `npm start` - Continuous development is `npm test` From 0c4be406322c32ca99ee8d36eab1dbfa0a0b6b65 Mon Sep 17 00:00:00 2001 From: Pomax Date: Mon, 14 Sep 2020 08:38:33 -0700 Subject: [PATCH 4/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f33ee548..aa7ad82b 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ See https://github.com/Pomax/BezierInfo-2/issues/257 for the current rewrite sta ## Building everything -Use the latest Node v14, with all dependencies installed. Nnote that [node-canvas](https://github.com/Automattic/node-canva) has [special instructions](https://github.com/Automattic/node-canvas/wiki/Installation:-Windows) because it's going to have to compile itself (however, JPEG support is not needed for this project). +Use the latest Node v14, with all dependencies installed via `npm install`. Note that [node-canvas](https://github.com/Automattic/node-canva) has [special instructions](https://github.com/Automattic/node-canvas/wiki/Installation:-Windows) because it's going to have to compile itself (however, JPEG support is not needed for this project). - The general single-build-pass command is simply `npm start` - Continuous development is `npm test` From 7f546eb5d8e05326628504848d35f3176c5909dd Mon Sep 17 00:00:00 2001 From: Pomax Date: Mon, 14 Sep 2020 08:41:30 -0700 Subject: [PATCH 5/5] Update README.md --- README.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index aa7ad82b..7598dbd4 100644 --- a/README.md +++ b/README.md @@ -15,15 +15,13 @@ Use the latest Node v14, with all dependencies installed via `npm install`. Note - The general single-build-pass command is simply `npm start` - Continuous development is `npm test` -Specialised commands: +#### Specialised commands: -- `pretty` runs prettier over the resultant HTML files -- `link-checker` runs link checking on the resultant HTML files -- `polish` runs `pretty` followed by `link-checker` -- `svgo:pretty` runs a script that reformats the SVG files to an easier-for-humans form (**note: might be broken?)** -- `clean` cleans up the timing file and temp directory -- `lint:tools` runs prettier on all javascript in the `src` dir -- `lint:lib` runs prettier on all site javascript (including the custom element code) +- `polish` runs `prettier` on the final .html files, as well as `link-checker` to make sure there are no dead links in the content. + +#### Even more specialized commands: + +Please see the package.json `"scripts"` section for the full list of commands. Most of these are just build chain steps, and running them on their own basically makes no sense. ## Weird personal dependencies?