summaryrefslogtreecommitdiffstats
path: root/README.txt
diff options
context:
space:
mode:
authorPiotr Dziwinski <piotrdz@gmail.com>2012-04-17 00:32:13 +0200
committerPiotr Dziwinski <piotrdz@gmail.com>2012-04-17 00:32:13 +0200
commit68da2c9b769ac068cb46695e5cddd66b33fc9a51 (patch)
treea744dd6a5c8c0dac7f24d49f62d7b15131d787ee /README.txt
parent7cd9f49e591be9e464ec151cc3bd8af3f95c35ef (diff)
downloadcolobot-68da2c9b769ac068cb46695e5cddd66b33fc9a51.tar.gz
colobot-68da2c9b769ac068cb46695e5cddd66b33fc9a51.tar.bz2
colobot-68da2c9b769ac068cb46695e5cddd66b33fc9a51.zip
Rewritten README.txt; added HOWTO.txt
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt52
1 files changed, 15 insertions, 37 deletions
diff --git a/README.txt b/README.txt
index 591ab15..c58d6e6 100644
--- a/README.txt
+++ b/README.txt
@@ -1,46 +1,24 @@
-EN: MinGW development branch
+Welcome to Colobot project repository
-Status
+This repository contains the source files of Colobot game released on open source license (GNU GPLv3) by the producer Epitec CH.
+The sources were released and the rights granted to a group of Polish Colobot fans centered around the site http://colobot.cba.pl/
+This repository contains only the source code of the game. The necessary data files will soon be available as a separate download.
+For now, though, you can download the original download package released by Epitec (the link is on http://colobot.cba.pl/ site).
-This branch will serve as the place for continued work in running the project under CMake and MinGW.
-The branch will be strictly tied to the master, but nevertheless separate so as not to break anything.
+For more information on the project, see the wiki pages.
-Instructions for compiling and running with MinGW.
+Status
-1. Download and install MinGW and MSYS:
+Our first goal has been reached now: the project has been successfully ported to CMake build system and MinGW compiler
+from the original MSVC6 project.
-2. When installing, select all available components
-3. In the file src/CMakeLists.txt, change "set(DXSDK_DIR "c:/dxsdk") to the directory, where you have DirectX SDK (version 8.1)
- (the slashes must be in this form: /, not \)
-4. Run MinGW console from the shortcut in menu start
-5. Change to the directory where you have the Colobot sources: "cd /c/where/the/sources/are"
-6. "cmake -G 'MSYS Makefiles' ."
-7. "make"
-8. Everything should compile without errors
-9. Copy bin/colobot.exe, bin/CBot/libCBot.dll and from the directory, where MinGW is installed
- bin/libgcc_s_dw2-1.dll and bin/libstdc++-6.dll to where you have the data files colobot*.dat
-10. Run colobot.exe with -nocd option
+Now our goal is to port the game to OpenGL and SDL, thus making it multiplatform. Further goals include adding
+new features to the game, though that will be decided later on.
+Compiling and running the game
-PL: Gałąź rozwojowa MinGW
+For these instructions see HOWTO.txt file.
-Status
+Contact
-Gałąź ta posłuży za miejsce do kolejnych prac nad uruchomieniem projektu pod MinGW.
-Będzie ścisle związana z główną, ale mimo wszystko osobna, żeby niczego nie zepsuć.
-
-Instrukcja jak skompilować i uruchomić pod MinGW
-
-1. Ściągamy i instalujemy MinGW i MSYS:
- http://sourceforge.net/projects/mingw/files/Installer/mingw-get-inst/mingw-get-inst-20111118/
-2. Przy instalacji zaznaczamy wszystkie komponenty do instalacji
-3. W pliku src/CMakeLists.txt zmieniamy set(DXSDK_DIR "c:/dxsdk") na katalog, gdzie jest zainstalowany DirectX SDK (w wersji 8.1)
- (slashe mają być właśnie w takiej postaci: / a nie \)
-4. Uruchamiamy MinGW console ze skrótu w menu start
-5. Przechodzimy do katalogu, gdzie są źródła: "cd /c/tam/gdzie/sa/zrodla"
-6. "cmake -G 'MSYS Makefiles' ."
-7. "make"
-8. Wszystko powinno się skomplikować bez błędów
-9. Kopiujemy bin/colobot.exe, bin/CBot/libCBot.dll i z katalogu, gdzie jest zainstalowany MinGW
- bin/libgcc_s_dw2-1.dll i bin/libstdc++-6.dll do miejsca, gdzie mamy pliki z danymi colobot*.dat
-10. Odpalamy colobot.exe z -nocd
+If you want to help in the project, please contact us on the forum on our website (there is also an English board).