Skip to content

Commit e37d67f

Browse files
committed
Update README.md
Add content for general consumption.
1 parent f1ffaeb commit e37d67f

File tree

1 file changed

+39
-3
lines changed

1 file changed

+39
-3
lines changed

README.md

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,40 @@
1-
TinCanJava
2-
==========
1+
A Java library for talking TinCan to the world.
32

4-
TinCan Java Client Library
3+
http://tincanapi.com/
4+
5+
This library uses Maven for project management, building, etc. It outputs Maven artifacts.
6+
7+
Building
8+
--------
9+
10+
Check out the source:
11+
12+
git clone https://github.com/RusticiSoftware/TinCanJava.git
13+
cd TinCanJava
14+
15+
With the repo cloned copy the `src/test/resources/lrs.properties.template` file
16+
to `src/test/resources/lrs.properties` and adjust the values to point to a valid LRS. Then
17+
build the project using:
18+
19+
mvn install
20+
21+
This will download dependencies (that are not already locally available) and build and test the
22+
artifact. The result will be in `target/tincan-0.2.5-SNAPSHOT.jar`. To build a specific version
23+
of the library you will need to checkout to the tag for that version first, such as:
24+
25+
git checkout tincan-0.2.4
26+
27+
And then do `mvn install`, which will provide `target/tincan-0.2.4.jar`.
28+
29+
Releasing
30+
---------
31+
32+
See http://maven.apache.org/maven-release/maven-release-plugin/index.html.
33+
34+
mvn release:prepare -DdryRun=true
35+
mvn release:clean
36+
mvn release:prepare
37+
mvn release:perform
38+
39+
At some point in the future we plan to make the maven artifacts available via some publicly
40+
available repository.

0 commit comments

Comments
 (0)