Document pre-requisites

[stevage]

I was quite surprised to discover that after following the install instructions, and eventually getting to the troubleshooting page, it seems that Chromium is a requirement.

Could I suggest that this (and other pre-reqs) be documented? (Preferable in the "Installing ReLaXed" section...)

[Zulko]

In theory in should not be a prerequisite - ReLaXed installs its own Chromium instance via Puppeteer. But in some cases your machine will be lacking some dependencies (which dont prevent ReLaXed installation, but cause problems at run time) so the troubleshooting section suggests asking your system to install chromium as a quick way to get these dependencies.

With which OS did you try and what was the error message ?

[stevage]

OIC. It's OSX. Installing according to all the instructions (including npm install) was fine, but at runtime:

module.js:487
    throw err;
    ^

Error: Cannot find module 'perf_hooks'
    at Function.Module._resolveFilename (module.js:485:15)
    at Function.Module._load (module.js:437:25)
    at Module.require (module.js:513:17)
    at require (internal/module.js:11:18)
    at Object.<anonymous> (/Users/stevebennett/odev/play/relaxed/src/index.js:6:25)
    at Module._compile (module.js:569:30)
    at Object.Module._extensions..js (module.js:580:10)
    at Module.load (module.js:503:32)
    at tryModuleLoad (module.js:466:12)
    at Function.Module._load (module.js:458:3)

[stevage]

Seems that perf_hooks is a built in module in later versions of Node, so I'll see if upgrading works. Which brings me back to my original point :) You should document the minimum required version of Node.

[stevage]

Upgrading Node to 10.0.0 did solve the problem and I've now got to "hello world" status.

Couple of other observations:

• running 'relaxed' with no arguments produces a stack trace TypeError: Cannot read property 'substr' of undefined
• running relaxed test.pug doesn't produce a pdf until the source file changes.

[Zulko]

Closing this. If other people use a version of Node that doesnt support async I'll add a line in the README. Too laxy to dissect now but i think node 8 should be a minimum requirement.

[DanielRuf]

Related #30