diff --git a/README.md b/README.md index 8b956c2..ff9c44e 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,39 @@ -# ![icon.png](https://bitbucket.org/repo/r5g9yq/images/265537834-icon.png) README # +# README # ![CI](https://github.com/adrido/MinetestMapperGUI/workflows/CI/badge.svg) MinetestMapperGui is a program written in C++ using the Qt framework that executes the minetestmapper over an graphical interface. -The Windows downloads include a copy of minetest mapper by Rogier-5 -### What is this repository for? ### +## Note ## +This Repository only contains the MinetestmapperGUI, If you are searching the full Package (including minetestmapper) please look [here](https://github.com/adrido/MinetestMapperGUI-Bundle). -* Quick summary -* Version -* [Learn Markdown](https://bitbucket.org/tutorials/markdowndemo) +## Getting Started ## -### How do I get set up? ### +### Installing ### -* Summary of set up -* Configuration -* Dependencies -* Database configuration -* How to run tests -* Deployment instructions +The easiest way is to grab the latest Installer from the [Release page](/adrido/MinetestMapperGUI/releases) for your platform and install it. +If it isn't available you can easyly compile it yourself. -### Contribution guidelines ### +## Building MinetestMapperGUI yourself ## -* Writing tests -* Code review -* Other guidelines +### Requirements ### -### Who do I talk to? ### +* A modern C++ compiler +* Qt-Framework +* CMake -* Repo owner or admin -* Other community or team contact \ No newline at end of file +### Compiling ### + +``` +cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_PORTABLE=TRUE . +cmake --build . --config Release +``` + +### Creating a package ### + +``` +cpack -G ZIP +``` +Of course, you can use every cpack generator you want. If your favourite one is not available, feel free to create a Pull Request + +## Versioning + +We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](/adrido/MinetestMapperGUI/tags).