From fc692e6779ebf28c181f1933333cdaf921c1faba Mon Sep 17 00:00:00 2001
From: fgsfds <pvt.fgsfds@gmail.com>
Date: Fri, 18 Aug 2017 16:44:15 +0300
Subject: [PATCH] added README

---
 README             | 25 +++++++++++++++++++++++++
 build.bat          |  4 ----
 build_headless.bat |  4 ----
 clean.bat          | 13 -------------
 4 files changed, 25 insertions(+), 21 deletions(-)
 create mode 100644 README
 delete mode 100644 build.bat
 delete mode 100644 build_headless.bat
 delete mode 100644 clean.bat

diff --git a/README b/README
new file mode 100644
index 0000000..478775a
--- /dev/null
+++ b/README
@@ -0,0 +1,25 @@
+D2DF-SDL
+---------
+
+Doom 2D Forever (https://github.com/pss88/DF) adapted for use with the FreePascal Compiler
+and ported to SDL 2.0.
+
+Building
+---------
+
+Requirements:
+* FPC >= 3.0.0;
+* FMODEx >= 4.26.xx or SDL_mixer >= 2.0;
+* libenet >= 1.3.13;
+* SDL >= 2.0.
+
+Create the "tmp" and "bin" directories beforehand if they don't exist already. Then run
+
+cd src/game
+fpc -dUSE_FMOD -O3 -Fi../lib/vampimg -Fi../lib/vampimg/JpegLib -Fi../lib/vampimg/ZLib -Fu../lib/vampimg -Fu../lib/vampimg/JpegLib -Fu../lib/vampimg/ZLib -FE../../bin -FU../../tmp Doom2DF.dpr
+
+If you want SDL_mixer instead of FMOD, replace -dUSE_FMOD with -dUSE_MIXER.
+To build a headless (no video/audio, for dedicated servers) executable, add -dHEADLESS.
+Add -g -dDEBUG to enable debugging features.
+
+Windows binaries will require the appropriate DLLs (SDL2.dll, SDL2_mixer.dll or FMODEx.dll, ENet.dll).
diff --git a/build.bat b/build.bat
deleted file mode 100644
index a0b001a..0000000
--- a/build.bat
+++ /dev/null
@@ -1,4 +0,0 @@
-@echo off
-cd "./src/game"
-fpc -dUSE_FMOD -MDELPHI -O2 -Fi../lib/vampimg -Fi../lib/vampimg/JpegLib -Fi../lib/vampimg/ZLib -Fu../lib/vampimg -Fu../lib/vampimg/JpegLib -Fu../lib/vampimg/ZLib -FE../../bin -FU../../tmp Doom2DF.dpr
-cd "../.."
diff --git a/build_headless.bat b/build_headless.bat
deleted file mode 100644
index fb27ef2..0000000
--- a/build_headless.bat
+++ /dev/null
@@ -1,4 +0,0 @@
-@echo off
-cd "./src/game"
-fpc -dUSE_FMOD -dHEADLESS -MDELPHI -O2 -Fi../lib/vampimg -Fi../lib/vampimg/JpegLib -Fi../lib/vampimg/ZLib -Fu../lib/vampimg -Fu../lib/vampimg/JpegLib -Fu../lib/vampimg/ZLib -FE../../bin -FU../../tmp -oDoom2DF_H.exe Doom2DF.dpr
-cd "../.."
diff --git a/clean.bat b/clean.bat
deleted file mode 100644
index a9c92ee..0000000
--- a/clean.bat
+++ /dev/null
@@ -1,13 +0,0 @@
-@echo off
-del /S "tmp\*.res"
-del /S *.~*
-del /S *.dcu
-del /S *.ddp
-del /S *.o
-del /S *.ppu
-del /S *.a
-del /S *.or
-del /S *.rsj
-del /S *.lps
-del "src\game\CustomRes.obj"
-del "src\game\*.exe"
-- 
2.29.2