Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Readme not available when run from jar instead of class files #323

Closed
hanslovsky opened this issue Sep 11, 2019 · 0 comments · Fixed by #324
Closed

Readme not available when run from jar instead of class files #323

hanslovsky opened this issue Sep 11, 2019 · 0 comments · Fixed by #324
Labels
bug Something isn't working

Comments

@hanslovsky
Copy link
Collaborator

The readme is not available in the help dialog (F1) when run from jar (i.e. in most cases) instead of from class files (e.g. when run from IDE). This is probably because <root>/src/main/README.md is a symlink to <root>/README.md.

Fix: Remove that symlink and copy README.md during validate phase of maven:
https://stackoverflow.com/a/32081483/1725687
@hanslovsky hanslovsky added the bug Something isn't working label Sep 11, 2019
@hanslovsky hanslovsky mentioned this issue Sep 11, 2019
Merged
hanslovsky added a commit that referenced this issue Sep 11, 2019
@hanslovsky
Merge pull request #324 from saalfeldlab/copy-readme-instead-of-symlink
731dee3 
[BUGFIX] The sym-linked `README.md` (into `src/main/resources`) was not available in the packaged jars (#323). Instead, copy `README.md` and `img` into `target/classes` and also convert `README.md` into `target/classes/README.html` at runtime. Images are still not displayed for readme from jar files but that can be resolved in a separate issue.
@hanslovsky hanslovsky mentioned this issue Sep 11, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

copy readme instead of symlink saalfeldlab/paintera
1 participant
@hanslovsky