Skip to content

Commit c2dfe12

Browse files
committed
More info about nodejs.
nodejs is required to build the HTML, not only to run the server locally. Moreover, some systems (.e.g, Ubuntu) install a 'nodejs' executable, but the building process searches for a 'node' one when building highlights, and therefore it is required to link or alias the real executable.
1 parent fa16ed9 commit c2dfe12

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,14 @@ To build the documentation web pages, simply run
6060

6161
$ make html
6262

63+
Please note that you will need to have [nodejs](https://nodejs.org)
64+
installed to produce HTML content with the above command.
65+
Moreover, depending on your system and installation, you could need
66+
to either *alias* or *link* the [nodejs](https://nodejs.org) executable
67+
so that you can run a command `node`. For instance:
68+
69+
$ ln `which nodejs` /usr/bin/node
70+
6371
After the pages have been generated, you can view them on your local
6472
computer by starting the included `app.pl` program:
6573

0 commit comments

Comments
 (0)