README.md
1# Java library and sample project to view Tiled files
2
3## Folders description
4
5* `libtiled-java` - contains source code for a library that adds support of Tiled maps to your java project.
6* `tmx-viewer-java` - sample project, that uses `libtiled-java` to view Tiled map files.
7
8Every folder contains a `README.md` related to its contents.
9
10
11
12## Packaging the project
13
14Make sure you have properly installed [Apache Maven](https://maven.apache.org/) on your computer.
15
16Open current folder in terminal (cmd, power shell, etc) and run the command:
17
18 mvn package
19
20As the command run has completed, check the following folders:
21
22`/libtiled-java/target` and `tmx-viewer-java/target` for generated jar files.
23