diff --git a/README.md b/README.md index 950e5b8..e92e384 100644 --- a/README.md +++ b/README.md @@ -1 +1,25 @@ # c47edit + +A scene editor for Hitman: Codename 47. + +Licensed under the GPL 3. + +[Download compiled release](https://github.com/AdrienTD/c47edit/releases) + +![Screenshot](docs/shot_001.png) + +## Usage + +See the [help.md](docs/help.md) file. + +## Compiling + +The program requires Visual Studio 2010 or a more recent version (as it's using some C++11 features) to be compiled and will only work on Windows. + +* If you have Visual Studio 2017, you can open the project files that are included in this repository to compile the program. +* Or you can also use the Visual Studio / Windows SDK command prompt and run the **build.bat** file to build the editor. + +## Libraries used + +* [Dear ImGui](https://github.com/ocornut/imgui) (MIT license) for the GUI +* [Miniz](https://github.com/richgel999/miniz) (MIT license) for ZIP archive (de)compression diff --git a/help.md b/docs/help.md similarity index 100% rename from help.md rename to docs/help.md diff --git a/docs/shot_001.png b/docs/shot_001.png new file mode 100644 index 0000000..0bc680a Binary files /dev/null and b/docs/shot_001.png differ