Unverified Commit a71cdf50 authored by Jay Billings's avatar Jay Billings Committed by GitHub

Updated the README before the talk.

Signed-off-by: Jay Billings's avatarJay Jay Billings <jayjaybillings@gmail.com>
parent 3bca337c
# The Eclipse Integrated Computational Environment (ICE) Main Repository
Please see [our wiki](https://wiki.eclipse.org/ICE) for detailed information about Eclipse ICE, including where to download binaries.
Please see [the website](https://www.eclipse.org/ice) for more information on the project.
Build instructions are available [on our wiki too](http://wiki.eclipse.org/ICE_Build_Instructions).
## Build Instructions
Contributions follow the standard Eclipse mechanisms and you should check out our [CONTRIBUTING.md](https://github.com/eclipse/ice/blob/master/CONTRIBUTING.md) file for more information. If you are looking at this, then you are most likely using Git and can start the process by issuing
a pull request on our GitHub repo.
Checkout the project and from the org.eclipse.ice.build directory execute
```bash
mvn clean install
```
## Using the project generators
Once the build is complete, use the project generators to get started with a new Eclipse ICE project. From the shell, execute the following for a basic project:
```bash
mvn archetype:generate -DarchetypeGroupId=org.eclipse.ice -DarchetypeArtifactId=data-element-archetype -DarchetypeVersion=1.0-SNAPSHOT -DgroupId=com.test -DartifactId=testApp
```
For a web form project, execute the following
```bash
mvn archetype:generate -DarchetypeGroupId=org.eclipse.ice -DarchetypeArtifactId=data-element-webform-archetype -DarchetypeVersion=1.0-SNAPSHOT -DgroupId=com.test -DartifactId=testApp
```
The group and artifact ids above are examples and should be replaced with the correct ids for your use case.
# Data Element Example
There are a number of examples in the test and org.eclipse.ice.renderer packages. There is also a [gist available](https://code.ornl.gov/snippets/109).
# Commands Examples
Examples for using the Commands tools are available [in the demo bundle](https://github.com/eclipse/ice/tree/next/org.eclipse.ice.demo/src/org/eclipse/ice/demo/commands).
# Getting started on development
If you're using Eclipse for development, you need to install Lombok into the Eclipse environment so that Eclipse knows about the bytecode changes that Lombok makes during the build process. Instructions are available here: https://projectlombok.org/setup/eclipse
Contributions follow the standard Eclipse mechanisms and you should check out our [CONTRIBUTING.md](https://github.com/eclipse/ice/blob/master/CONTRIBUTING.md) file for more information. If you are looking at this, then you are most likely using Git and can start the process by issuing
a pull request on our GitHub repo.
If you're using Eclipse for development, you need to install Lombok into the Eclipse environment so that Eclipse knows about the bytecode changes that Lombok makes during the build process. Instructions are available [at the Lombok site](https://projectlombok.org/setup/eclipse).
Using the project generators
-
# Contacting the development team
Instructions for generating a new project with the maven archeytpes.
pull the org.eclipse.ice.archetypes project
make sure that the data element renderer and annotations projects are built as well
build the package and it should build the archetypes as well.
then you can use mvn archetype:generate -DarchetypeGroupId=org.eclipse.ice -DarchetypeArtifactId=data-element-archetype -DarchetypeVersion=1.0-SNAPSHOT -DgroupId=com.test -DartifactId=testApp
Note* use -DarchetypeArtifactId=data-element-webform-archetype for the webform archetype
replace the group and artifact id's with whatever.
\ No newline at end of file
Please submit a ticket or pull request to contact the team. Alternatively, use the [ice-dev@eclipse.org mailing list](https://accounts.eclipse.org/mailing-list/ice-dev) to post questions.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment