cincheo / jsweet

A Java to JavaScript transpiler.
http://www.jsweet.org
Other
1.45k stars 160 forks source link

Build instructions #24

Closed davidmoten closed 8 years ago

davidmoten commented 8 years ago

I did mvn install and build failed due to the absence of an executable pandoc, node.

Can you document the build instructions/dependencies in the README.md please.

All seemed to work for me after I did the following:

sudo apt-get install pandoc nodejs
## sort out an executable name conflict with another package by opting for nodejs
sudo ln -s /usr/bin/nodejs /usr/bin/node
renaudpawlak commented 8 years ago

David, I have removed the pandoc generation from the pom.xml (it had nothing to do there) so that pandoc is not required to build the project anymore. I have also added a "How to build" section in README.md to make all this as clear as possible.

Regarding the nodejs issued, I have not met it myself, so I added a link in the readme file. Do you think that it would be possible that JSweet supports both node and nodejs command names so that it limits this kind of issue?

davidmoten commented 8 years ago

Thanks @renaudpawlak, changes to the doco look fine to me and are sufficient I think (I wouldn't add support for both node and nodejs executable names without more convincing use cases than this).