diff --git a/README b/README-OLD similarity index 100% rename from README rename to README-OLD diff --git a/README.MD b/README.MD new file mode 100644 index 0000000..eddcce2 --- /dev/null +++ b/README.MD @@ -0,0 +1,27 @@ +# LWJake2 + +Порт игры Quake2 с `C++` на `Java` + `lwjgl2`. + +Оригинальный порт: [github.com/flibitijibibo](https://github.com/flibitijibibo/LWJake2) + +Оригинальный "ридми": README-OLD + +## Сборка и запуск + +Для сборки необходим `gradle` версии `4.x`. + +Для запуска понадобятся оригинальные файлы игры `baseq2`, размещенные в корне проекта. + +``` +... +* baseq2/ +* licenses/ +* src/ +... +``` + +### Запуск через Gradle + +``` +gradle run +```