Skip to content

Commit

Permalink
Update readme and contribution.
Browse files Browse the repository at this point in the history
Signed-off-by: Achim Kraus <[email protected]>
  • Loading branch information
Achim Kraus committed Dec 6, 2017
1 parent 6dff6dd commit a6acd01
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 8 deletions.
9 changes: 7 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,16 @@ You can find all the details in the [Contributing via Git](http://wiki.eclipse.o

## Making your Changes

1. Consider to start with creating an issue on GitHub to discuss your plans and get the proper startup information.
1. Fork the repository on GitHub
1. Create a new branch for your changes
1. Make your changes
1. Create a new branch for your changes based on the 2.0.x branch.
Please note: work based on other branches without prior discussion in an issue, may be in vain.
1. If you use the eclipse IDE, please import our prefer formatter `eclipse-formatter-profile.xml` from the californium parent-folder and apply it to your changes (only :-) ).
1. Make your changes
1. Make sure you include test cases for non-trivial features/changes
1. Make sure the test suite runs successfully after you made your changes
1. If new files are created, provide a proper license header
(see license_header_template.txt and copy the adjusted javadoc comment to the top of your java file)
1. Commit your changes into the branch you created in step 2
1. Use descriptive and meaningful commit messages
1. If you have a lot of commits squash them into a single commit
Expand Down
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,18 +30,20 @@ to your `pom.xml` (without the dots):
<dependency>
<groupId>org.eclipse.californium</groupId>
<artifactId>californium-core</artifactId>
<version>1.0.4</version>
<version>1.0.6</version>
</dependency>
...
</dependencies>
...
```

If you want to give the most recent milestone a try, use version `2.0.0-M2` instead.
If you want to give the most recent milestone a try, use version `2.0.0-M6` instead.

##### Current Master Builds
Please Note: in the meantime, a lot of new bugfixes and improvements has been made in branch 2.0.x, which had affected the API and could not be back-ported to the other branches. Even if 2.0.x is still under development, we recommend to focus on using the 2.0.x branch, especially for larger changes.

You can also be bold and try out the most recent build from `master`.
##### Current Builds

You can also be bold and try out the most recent build from `2.0.x`.
However, we are not publishing those to Maven Central but to Californium's project repository at Eclipse only.
You will therefore need to add the Eclipse Repository to your `pom.xml` first:

Expand All @@ -56,7 +58,7 @@ You will therefore need to add the Eclipse Repository to your `pom.xml` first:
...
</repositories>
```
You can then simply depend on `1.1.0-SNAPHOT`.
You can then simply depend on `2.0.0-SNAPSHOT`.

# Eclipse

Expand All @@ -77,8 +79,10 @@ In IntelliJ, choose *[File.. &raquo; Open]* then select the location of the clon

# Interop Server

A test server is running at [coap://iot.eclipse.org:5683/](coap://iot.eclipse.org:5683/).
A test server is running at <a href="coap://californium.eclipse.org:5683/">coap://californium.eclipse.org:5683/</a>.
It is an instance of the `cf-plugtest-server` from the demo-apps.
The root resource responds with its current version.
More information can be found at [http://californium.eclipse.org/](http://californium.eclipse.org/).

Another interop server with a different implementation can be found at
[coap://coap.me:5683/](coap://coap.me:5683/).
Expand Down
17 changes: 17 additions & 0 deletions license_header_template.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
/*******************************************************************************
* Copyright (c) <year (e.g. 2017)> <(company) name> and others.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Eclipse Distribution License v1.0 which accompany this distribution.
*
* The Eclipse Public License is available at
* http://www.eclipse.org/legal/epl-v10.html
* and the Eclipse Distribution License is available at
* http://www.eclipse.org/org/documents/edl-v10.html.
*
* Contributors:
* <(company) name> - initial creation
******************************************************************************/

Please replace all <symbolic name> tags with the information proper for you!

0 comments on commit a6acd01

Please sign in to comment.