clarify that docs must be built before make test
See comment in https://github.com/nodejs/node/issues/16650
Running make test
prior to running make doc
results in this error:
added 3 packages and updated 1 package in 1.717s
/bin/sh: out/doc/api/console.html: No such file or directory
Makefile:579: recipe for target 'out/doc/api/console.html' failed
make[1]: *** [out/doc/api/console.html] Error 1
Makefile:213: recipe for target 'test' failed
make: *** [test] Error 2
After running make doc
, make test
succeeds.
This PR updates BUILDING.md to clarify.
Checklist
-
make -j4 test
(UNIX), orvcbuild test
(Windows) passes -
tests and/or benchmarks are included -
documentation is changed or added -
commit message follows commit guidelines