[jbosstools-issues] [JBoss JIRA] (JBIDE-19590) Update module's README.md files with information about dependencies to other modules
Nick Boldt (JIRA)
issues at jboss.org
Fri Apr 17 10:27:18 EDT 2015
[ https://issues.jboss.org/browse/JBIDE-19590?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13060199#comment-13060199 ]
Nick Boldt commented on JBIDE-19590:
------------------------------------
How about just putting into the README.md a generic statement saying:
{quote}
To build this project, first look in the root pom.xml for references to other jbosstools-* projects.
You will need to build those locally (or resolve them using this settings.xml file [1]).
{quote}
[1] https://github.com/jbosstools/jbosstools-devdoc/blob/master/building/how_to_build_jbosstools_4.adoc#maven-settings
Why make it complicated when you can just tell people to RTFP?
> Update module's README.md files with information about dependencies to other modules
> ------------------------------------------------------------------------------------
>
> Key: JBIDE-19590
> URL: https://issues.jboss.org/browse/JBIDE-19590
> Project: Tools (JBoss Tools)
> Issue Type: Task
> Affects Versions: 4.3.0.Alpha2
> Reporter: Denis Golovin
>
> For almost every JBoss Tools module there are three major steps to configure eclipse workspace for development:
> 1. Set up target platform in preferences
> 2. Import JBT module sources into workspace
> 3. Import required JBT module sources into worksapce
> (1) and (2) are well documented in README.md files, but (3) is not (see forum reference for jbosstools-hibernate as an example).
--
This message was sent by Atlassian JIRA
(v6.3.11#6341)
More information about the jbosstools-issues
mailing list