README.md
1# Java TMX Viewer example
2
3This is a simple example application showing how to use libtiled-java to load
4and view a Tiled map file.
5
6## Opening the project in a modern IDE
7
8Just import this project as a `Maven project`, specifying the project `pom.xml`
9file location.
10
11## Trying it out from the command line
12
13The tmxviewer-java needs libtiled-java to be compiled first to add libtiled
14dependency to your local Maven repository.
15
16The [Apache Maven](https://maven.apache.org/) build tool is used to build from the command line.
17
18* Run `mvn clean install` in the libtiled-java directory to build libtiled.jar
19* Go to the `tmxviewer-java` directory and run `mvn clean install` there to compile it
20* Launch the `TMX Viewer` using `java -jar tmxviewer-<Version>.jar [file]`
21