From de1f11380cdaa01f68bbe8f68261b3176c9024ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jure=20=C5=A0orn?= Date: Wed, 28 Jul 2021 20:03:59 +0200 Subject: [PATCH] Updated parse.js documentation --- .gitignore | 3 +++ parse.js | 12 +++++++++--- 2 files changed, 12 insertions(+), 3 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b8ffe08 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +node_modules/ +package-lock.json + diff --git a/parse.js b/parse.js index c760811..69f53d0 100755 --- a/parse.js +++ b/parse.js @@ -1,12 +1,18 @@ #!/usr/bin/env node // Usage: node parse.js +// // Script that creates index.html out of web/template.html and README.md. // It is written in JS because this code used to be executed on the client side. -// To install dependencies run: -// $ npm install -g jsdom jquery showdown highlightjs -// If running on Mac and modules can't be found after installation add: +// To install the Node.js and npm run: +// $ sudo apt install nodejs npm # On macOS use `brew install ...` instead. +// To install dependencies globally, run: +// $ npm install -g jsdom jquery showdown highlightjs@9.12.0 +// If running on macOS and modules can't be found after installation add: // export NODE_PATH=/usr/local/lib/node_modules // to the ~/.bash_profile or ~/.bashrc file and run '$ bash'. +// To avoid problems with permissions and path variables, install modules +// into project's directory using: +// $ npm install jsdom jquery showdown highlightjs@9.12.0 const fs = require('fs');