diff --git a/README.md b/README.md index 725dc67..442260c 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,18 @@ -# Doppelspalt +# Doppelspalt LibGDX App + +## Overview + +![](preview.png) + +--- A [libGDX](https://libgdx.com/) project generated with [gdx-liftoff](https://github.com/tommyettinger/gdx-liftoff). -This project was generated with a template including simple application launchers and a main class extending `Game` that sets the first screen. - ## Platforms - `core`: Main module with the application logic shared by all platforms. - `lwjgl3`: Primary desktop platform using LWJGL3. - `html`: Web platform using GWT and WebGL. Supports only Java projects. -## Gradle -This project uses [Gradle](http://gradle.org/) to manage dependencies. -The Gradle wrapper was included, so you can run Gradle tasks using `gradlew.bat` or `./gradlew` commands. -Useful Gradle tasks and flags: -- `--continue`: when using this flag, errors will not stop the tasks from running. -- `--daemon`: thanks to this flag, Gradle daemon will be used to run chosen tasks. -- `--offline`: when using this flag, cached dependency archives will be used. -- `--refresh-dependencies`: this flag forces validation of all dependencies. Useful for snapshot versions. -- `build`: builds sources and archives of every project. -- `cleanEclipse`: removes Eclipse project data. -- `cleanIdea`: removes IntelliJ project data. -- `clean`: removes `build` folders, which store compiled classes and built archives. -- `eclipse`: generates Eclipse project data. -- `html:dist`: compiles GWT sources. The compiled application can be found at `html/build/dist`: you can use any HTTP server to deploy it. -- `html:superDev`: compiles GWT sources and runs the application in SuperDev mode. It will be available at [localhost:8080/html](http://localhost:8080/html). Use only during development. -- `idea`: generates IntelliJ project data. -- `lwjgl3:jar`: builds application's runnable jar, which can be found at `lwjgl3/build/lib`. -- `lwjgl3:run`: starts the application. -- `test`: runs unit tests (if any). - -Note that most tasks that are not specific to a single project can be run with `name:` prefix, where the `name` should be replaced with the ID of a specific project. -For example, `core:clean` removes `build` folder only from the `core` project. diff --git a/preview.png b/preview.png new file mode 100644 index 0000000..e27946c Binary files /dev/null and b/preview.png differ