Updated readme and cleanup pom files
This commit is contained in:
@@ -1,6 +1,39 @@
|
||||
|
||||
To build the whole application use:
|
||||
```Bash
|
||||
mvn -DskipTests=true --also-make --projects application install
|
||||
```
|
||||
# Overview
|
||||
The `ch.psi.fda.ui` project holds the GUI part of the FDA application. It consists of 3 Maven projects, a parent project, a project holding the
|
||||
application configuration itself (`fda.ui.application`) and a project holding the code (`fda.ui.module`).
|
||||
|
||||
Startup parameters and configurations are specificed in `fda.ui.application/src/main/resources/fda.conf`.
|
||||
Shell startup scripts are located in the `fda.ui.application/src/main/scripts`.
|
||||
|
||||
|
||||
|
||||
# Development
|
||||
The application is build via maven (use `-DskipTests=true` option to skip tests) . Use the toplevel `pom.xml` file to build the whole application. After the compilation
|
||||
and packaging the resulting application zip file will be located in `fda.ui.application/target`.
|
||||
|
||||
## Changing Version
|
||||
|
||||
In the ch.psi.fda Eclipse project
|
||||
* Change version in pom.xml (remove -SNAPSHOT)
|
||||
* Compile and deploy the new ch.psi.fda jar file (Eclipse) via maven
|
||||
* Run goal: `clean deploy`
|
||||
* Change version in pom.xml (add -SNAPSHOT)
|
||||
|
||||
In fda.ui.ee (Netbeans) project
|
||||
* Change used ch.psi.fda version in `fda.ui.module` project pom (section dependencies) to the version you compiled and deployed before
|
||||
* Change project version in pom.xml of all projects:
|
||||
* pom.xml
|
||||
* fda.ui.application
|
||||
* fda.ui.module
|
||||
* Change version in branding file:
|
||||
* `./branding/src/main/nbm-branding/modules/org-netbeans-core-windows.jar/org/netbeans/core/windows/view/ui/Bundle.properties`
|
||||
* Restart Netbeans (Workaround: due to compiling errors that cannot be otherwise easily resolved)
|
||||
* Right click on fda.ui.parent project and select `Clean and Build`
|
||||
* Start and test GUI from within Netbeans
|
||||
|
||||
## Release
|
||||
* Locate `fda.ui.application-<version>.zip` in `fda.ui.application/target`
|
||||
* Rename file to `fda-<version>.zip`
|
||||
* Upload file into the releases repository of artifactory (http://yoke/artifactory)
|
||||
|
||||
|
||||
@@ -67,27 +67,4 @@
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
|
||||
<profiles>
|
||||
<profile>
|
||||
<id>deployment</id>
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>org.codehaus.mojo</groupId>
|
||||
<artifactId>nbm-maven-plugin</artifactId>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>extra</id>
|
||||
<goals>
|
||||
<goal>autoupdate</goal>
|
||||
<goal>webstart-app</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
</profile>
|
||||
</profiles>
|
||||
</project>
|
||||
|
||||
@@ -9,12 +9,8 @@
|
||||
|
||||
<name>ch.psi.fda.ui.parent</name>
|
||||
|
||||
<!-- Special NetBeans artifact repository -->
|
||||
<repositories>
|
||||
<!--
|
||||
Repository hosting NetBeans modules, especially APIs.
|
||||
Versions are based on IDE releases, e.g.: RELEASE691
|
||||
To create your own repository, use: nbm:populate-repository
|
||||
-->
|
||||
<repository>
|
||||
<id>netbeans</id>
|
||||
<name>NetBeans</name>
|
||||
|
||||
Reference in New Issue
Block a user