Merge pull request #34 from LucvandenBrand/develop

Version 0.4.0

CMakeLists.txt

@@ -1,9 +1,17 @@
 cmake_minimum_required(VERSION 3.9)
 project(Tiled2GBA)
 
-# Source location.
-file(GLOB_RECURSE SOURCES src/*.c src/*.cpp src/*.h src/*.hpp src/*.inl)
-
 # Compilation settings.
 set(CMAKE_CXX_STANDARD 17)
-add_executable(${PROJECT_NAME} ${SOURCES})
+
+# Build Tiled2GBA
+file(GLOB_RECURSE PROJECT_SOURCES src/*.c src/*.cpp src/*.h src/*.hpp src/*.inl)
+add_executable(${PROJECT_NAME} ${PROJECT_SOURCES})
+
+# Build GBFS
+file(GLOB_RECURSE GBFS_SOURCES tools/gbfs/*.c tools/gbfs/*.h)
+add_executable(gbfs ${GBFS_SOURCES})
+
+# Build PADBIN
+file(GLOB_RECURSE PADBIN_SOURCES tools/padbin/*.c tools/padbin/*.h)
+add_executable(padbin ${PADBIN_SOURCES})

README.md

@@ -4,12 +4,12 @@ Simple CLI for converting [Tiled](https://www.mapeditor.org) maps to data the **
 Special thanks to [Jasper Vijn](https://www.coranac.com) for providing a great tutorial on GBA development!
 
 ## Releases
-You can download binary releases for Linux [here](https://github.com/LucvandenBrand/Tiled2GBA/releases).
+You can download binary releases [here](https://github.com/LucvandenBrand/Tiled2GBA/releases).
 
 ## Usage
 Tiled2GBA can generate both compilable C code and appendable binary data. 
 The latter is recommended (no need to recompile your project for changes in assets), 
-and can be used with [GBFS](http://www.pineight.com/gba/#gbfs) in order to access it (see the example).
+and can be used with [GBFS](http://www.pineight.com/gba/#gbfs) in order to access it (see the `tools` folder).
 
 ### Generating C code
 Simply call `Tiled2GBA` from your command prompt, and provide a `map.tmx` and `map.c map.h` as
@@ -18,15 +18,23 @@ For example, `Tiled2GBA assets/map.tmx src/map.c src/map.h` would output compila
 into the `src` folder.
 
 ### Generating binary data
-Simply call `Tiled2GBA` from your command prompt, and provide a `map.tmx` and `map.bin` as
+Call `Tiled2GBA` from your command prompt with the `--binary` option, and provide a `map.tmx` and `map.bin` as
 input and output parameters respectively. 
-For example, `Tiled2GBA assets/map.tmx assets/map.bin` would output appendable binary data
+For example, `Tiled2GBA assets/map.tmx assets/map.bin --binary` would output appendable binary data
 into the `assets` folder.
 
 You can use the `--help` command for more information.
 
 ## Development
-This project is written in C++ and contains a very simple Makefile to help you compile it.
+This project is written in C++ and contains a very simple [CMake](https://cmake.org/) file to help you compile it.
+Without an IDE like CLion (greatly recommended!) you can build this project by calling:
+
+1. `mkdir build`
+2. `cd build`
+3. `cmake ..`
+4. `make`
+
+This should result in a cute little `Tiled2GBA` binary.
 
 ### Contributing
 Contributions are always welcome! You can make a contribution by:
@@ -39,6 +47,6 @@ The **develop** branch is meant for in-development unstable releases,
 whilst the **master** branch is meant for stable production-ready releases.
 
 ### Licence
-All source files are protected under the MIT Licence, except for the included libraries in `lib`.
-The used libraries are open-source, but please read their included licenses for their specific
-terms and conditions.
+All source files are protected under the MIT Licence, except for the included libraries in `src/lib`, 
+`tools/gbfs` and `tools/padbin`. The used libraries are open-source, but please read their included licenses for 
+their specific terms and conditions.