write and commit instructions for maven install

[Jason Lauman]

Create a top-level README.txt file with build instructions. The instructions should describe the circular dependency between the adk-generator and adk-library that causes the build to be complicated.

[Jon Nicholson (jonicholson)]

I've just tried to get the projects to compile following the instructions provided. I managed to get some jars created, but I really struggled to follow the instructions provided.

I got the most up to date snapshot of the repository this morning. Please note that although I am familiar with Java/Eclipse, I am new to Maven. Here are the issues I found while attempting to compile them:

1) Not everyone has the Eclipse Marketplace, e.g. if they have an Eclipse Classic install or other distro. Instructions are fine for new users, but it would be good to add a small section stating what plugins need to be installed in existing installations that do not have access to Eclipse Marketplace (something essentially similar to "go to install new software, select all available repositories, search for Maven, install all that appear in the list").

2) When i import the projects I get the following error:
- "No marketplace entries found to handle maven-dependency-plugin:2.2:unpack-dependencies in Eclipse."
with four suberrors in the form of:
- "No marketplace entries found to handle Execution unpack-sdo-src, in core/pom.xml in Eclipse."
for core, locale/au, locale/uk, locale/us

Is this an issue with the "cyclic dependency" between projects? If so then the installation instructions needs to tell the user that these messages are expected. (After having written this comment, it occurs that this could be caused by my local repository not having the necessary plugins yet. If this is the case, it should still be mentioned as an expected condition that can be ignored)

3) From what I had downloaded following the instructions, 8 projects are to be added to my workspace, not 5. These are:
- adk-examples-sifquery
- adk-examples-tinysis
- adk-generator
- adk-library-au
- adk-library-core
- adk-library-parent
- adk-library-uk
- adk-library-us

4) When doing the build on adk-generator, it failed stating no goal was selected. From the later instructions of manually executing Maven it appears that "package" is the goal I should use, so i typed this in and I got one step further. Eclipse does not list the "package" goal in the list I can select, and I don't know how that would be fixed, but there should be some documentation to explain this.

5) While running the package build, I was then confronted with an error telling me it could not find my Java compiler! After some searching it turns out that to fix this I have to set my Eclipse JRE to the JDK (yes, JAVA_HOME does point to my JDK directory). I realise this isn't an issue with the Open-ADK, but it would be nice to have this highlighted in an FAQ section.

6) While compiling I get this warning:
SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
According to the URL, I need to add a library to my classpath. Which one? This requirement should be documented in the instructions, perhaps as an FAQ.

--- At this point I have managed to build the adk-generator project. I am now trying to build adk-library-parent.

7) Although i don't believe this causes any direct issu...

[Jon Nicholson (jonicholson)]

Additionally, the section title "Part 2 command line build using Maven 2.x**" is incompatible with the first paragraph stating that "This build requires the installation of Maven 3.x"

[Jon Nicholson (jonicholson)]

I've just tried following the instructions. I did everything from within Eclipse, i.e. not using the command line, so my experience is based on using the Bazaar Eclipse plugin (http://wiki.bazaar.canonical.com/BzrEclipse) to get the trunk and the Maven installation inside Eclipse.

I generally found the process to be simpler than the first version, and it's really nice to have the source all bundles into a project for you.

1) I downloaded the trunk using the Bazaar Eclipse plugin. As I'm not using the command line, I still had to import existing Maven projects from the trunk to allow me to use Maven commands. This worked, and gives me the option to have 3 projects (SIFQuery, TinySIS, and the adk-library), I selected the adk-library. I get this error when doing so:

No marketplace entries found to handle Execution generate-data-model-sources, in /open-adk-java/adk-library/pom.xml in Eclipse. Please see Help for more information.

However, hitting "Finish" still gives me the project etc without a problem.

2) I performed a Maven build with the profile "UK" and the goal "eclipse:eclipse". All other options were left with their default values. This completed successfully.

3) I performed a Maven build with the profile "UK" and the goal "install". All other options were left with their default values. This completed successfully.

4) In the open-adk-library/target folder I used the openadk-library-1.0.0-SNAPSHOT-UK.jar file, which worked in our agent nicely once we reorganised the imports to the new package names.

My opinion is the new version of the instructions and project structure is much improved, and fantastic work.

[Brian Sneddon (brian-sneddon)]

Jon,

Thanks for the descriptive feedback. It is very helpful for us in our
efforts to continue improvements on the OpenADK.

On 9/16/11 5:19 AM, "Jon Nicholson" <email address hidden> wrote:

> I've just tried following the instructions. I did everything from within
> Eclipse, i.e. not using the command line, so my experience is based on
> using the Bazaar Eclipse plugin
> (http://wiki.bazaar.canonical.com/BzrEclipse) to get the trunk and the
> Maven installation inside Eclipse.
>
> I generally found the process to be simpler than the first version, and
> it's really nice to have the source all bundles into a project for you.
>
> 1) I downloaded the trunk using the Bazaar Eclipse plugin. As I'm not
> using the command line, I still had to import existing Maven projects
> from the trunk to allow me to use Maven commands. This worked, and gives
> me the option to have 3 projects (SIFQuery, TinySIS, and the adk-
> library), I selected the adk-library. I get this error when doing so:
>
> No marketplace entries found to handle Execution generate-data-model-
> sources, in /open-adk-java/adk-library/pom.xml in Eclipse. Please see
> Help for more information.
>
> However, hitting "Finish" still gives me the project etc without a
> problem.
>
> 2) I performed a Maven build with the profile "UK" and the goal
> "eclipse:eclipse". All other options were left with their default
> values. This completed successfully.
>
> 3) I performed a Maven build with the profile "UK" and the goal
> "install". All other options were left with their default values. This
> completed successfully.
>
> 4) In the open-adk-library/target folder I used the openadk-
> library-1.0.0-SNAPSHOT-UK.jar file, which worked in our agent nicely
> once we reorganised the imports to the new package names.
>
>
> My opinion is the new version of the instructions and project structure is
> much improved, and fantastic work.