Browse Source

- updated README.md file

Patrick-Christopher Mattulat 3 years ago
parent
commit
57cb295a49
1 changed files with 5 additions and 17 deletions
  1. 5 17
      README.md

+ 5 - 17
README.md

@@ -1,6 +1,6 @@
 # Lynar Moon Engine 1.5.0
 
-This repository contains the most recent version of the Lynar Moon Engine.
+This repository contains the most recent release version of the Lynar Moon Engine.
 
 # Documentation
 
@@ -9,19 +9,7 @@ In addition to that there is an offline documentation in doc directory!
 
 # Installing
 
-There are many ways to build this library. The easiest way would be to run cmake and generate a library file which can be linked to your application. Note that you also will have to link the following libraries:
-
-- LynarMoon 
-- atomic
-- lynarmath 
-- dirhandler 
-- tfhandler 
-- clock
-- SDL2
-- SDL2main
-- SDL2_image
-- SDL2_ttf
-- SDL2_mixer
+To build this library just run cmake on CMakeLists.txt. A library file will be generated then. You just need to link this library to your application. After you did that you may begin developing your own game!
 
 On Windows:
 
@@ -30,7 +18,7 @@ On Windows:
 On Ubuntu (from source):
 
 - Open Terminal (is integrated in CLion) and navigate to SDL2
-> cd lib/SDL/SDL_source/SDL2
+> cd lib/SDL/src/SDL2
 - Start configure file
 > ./configure
 - make this file
@@ -38,11 +26,11 @@ On Ubuntu (from source):
 - install made file
 > sudo make install
 
-- Do this with lib/SDL_source/SDL2_image and the other 2 SDL libraries as well!
+- Do this with lib/SDL/src/SDL2_image and the other 2 SDL libraries as well! Note that you might need to install some additional dependencies to make SDL work on your machine!
 
 On Ubuntu (command line)
 
-> sudo apt-get install libsdl2-dev libwebp-dev libtiff-dev libvorbis-dev libflac-dev libfluidsynth-dev libmodplug-dev libsdl2-ttf-dev
+> sudo apt-get install libsdl2-dev libsdl2-image-dev libsdl2-ttf-dev libsdl2-mixer-dev
 
 Setup.txt