search

asciidocfx / AsciidocFX

Asciidoc Editor and Toolchain written with JavaFX 21 (Build PDF, Epub, Mobi and HTML books, documents and slides)
http://www.asciidocfx.com/
Apache License 2.0
1.88k stars 295 forks source link

Add easy build and execution instructions for developers #525

Open Ayowel opened 3 years ago

Ayowel commented 3 years ago

Setting-up JavaFX is a pain the first time and making it easier for new users to build Asciidocfx should encourage potential maintainers to send a fix.

This PR adds the plugin that should be used to run javafx applications locally (https://openjfx.io/openjfx-docs/maven) with maven as well as instructions to use it with minimal setup requirements.

EDIT : added a second commit to set jvm args from maven properties. It reuses what is already defined for the compiled published version to avoid future maintenance issues of both parameter sets.

rahmanusta commented 3 years ago

It is pretty clear changes, thank you!

I changed the target branch to development from master. There is a small conflict in pom.xml, could you please resolve the conflicts ?

Ayowel commented 3 years ago

Just rebased on development. Should be good for merge