Olga Pshenichnikova
Olga Pshenichnikova

Reputation: 1581

README.md for MAVEN project in NetBeans

I want add README.md file for in will be visible and editable in NetBeans 8.2 in Maven Java project type, But when the file lies in th project root it still unvisible in the IDE...

enter image description here

Upvotes: 2

Views: 2184

Answers (2)

Dmitry.M
Dmitry.M

Reputation: 2972

Interestingly enough there is a plugin for it. See at github or at netbeans portal To install it go to Tools -> plugins -> Available Plugins and search for readme. Choose plugin called Display readme files in project view. You can change which files to show on the Tools -> options -> Miscellaneous->Display more files panel:

enter image description here

UPDATE 2022:

Currently, the old NetBeans portal unavailable because it was decommissioned. You can download plugin from here and install manually. To install it manually, download the file readmeinprojectview-1.6.0.nbm then go to Tools -> Plugins -> Donwloaded -> Add Plugins. Then select the plugin and click Install.

enter image description here

Upvotes: 2

Manmohan_singh
Manmohan_singh

Reputation: 1804

Because readme.md is not part of project code. It is a descriptor file for marking down specific lines and paragraphs to highlight project details and it is used to generate the html summary you see at the bottom of projects on pages like GitHub.

It will be visible in the Files tab.

Upvotes: 2

Related Questions