Merge pull request #134 from vjon/docs_update

Update READMEs

README.md

@@ -10,8 +10,8 @@ MegaGlest is an entertaining free (freeware and free software)
 and open source cross-platform 3D real-time strategy (RTS) game,
 where you control the armies of one of seven different factions:
 Tech, Magic, Egypt, Indians, Norsemen, Persian or Romans. The
-game is setup in one of 17 naturally looking settings, which
+game is played in one of 17 naturally looking settings, which,
--like the unit models- are crafted with great appreciation for
+like the unit models, are crafted with great attention to
 detail. A lot of additional game data can be downloaded from
 within the game at no cost.
 
@@ -22,10 +22,12 @@ within the game at no cost.
 [![intro](http://megaglest.org/uploads/images/trailer3.png)]
 (http://downloads.megaglest.org/videos/megaglest_game_trailer_lq.webm)
 
-If you want compile MegaGlest yourself then you should read the
+If you want to compile MegaGlest yourself, you should read the following:
-[**tutorial**](https://docs.megaglest.org/MG/Development) or
+
-[tutorial2](https://github.com/MegaGlest/megaglest-source/wiki/Git-How-To)
+[Development Tutorial](https://docs.megaglest.org/MG/Development)
+
+[Git Workflow](https://github.com/MegaGlest/megaglest-source/wiki/Git-How-To)
 
 
-go to the [Main Repository](https://github.com/MegaGlest/megaglest-source)
+
-( e.g. from the fork ... )
+Return to the main (upstream) repository [**here**](https://github.com/MegaGlest/megaglest-source)

docs/README.compiling-linux.txt

@@ -16,8 +16,7 @@ around on the forums, e.g. http://forum.megaglest.org/?topic=1426#).
 
 --- 2.1 Prerequesites ---
 
-Before you can start compiling it, the game depends on and needs the following
+Compiling MegaGlest requires the following dependencies to be installed:
-tools and libraries to be present:
 
 * Standard GNU compiler and additional tools (g++ version 4.6.3 or later is
   required at the moment)
@@ -74,14 +73,8 @@ tools and libraries to be present:
 
 * libdl
 
-NOTE: We have produced a script that tries to install build dependencies on many
+NOTE: A script which tries to install build dependencies on many Linux distros
-Linux distros. The script is located in mk/linux/setupBuildDeps.sh
+is located in mk/linux/setupBuildDeps.sh
-
-If CMake reports that it cannot find some of the libraries, make sure that you
-also have the ...-dev(el) packages installed that some distributions provide.
-
-At this point we would like to thank all the authors of these helpful libraries 
-who made our development easy and straight forward.
 
 --- 2.2 Building ---
 
@@ -96,7 +89,7 @@ examine it and build manually using cmake.
 
 We provide MojoSetup based installers for Linux and NSIS based installers for
 Windows. By default, the Linux installers install to your home directory. The
-Windows installers install to %ProgramFiles%, so to the systems' global scope.
+Windows installers install to %ProgramFiles% (global system scope).
 
 There are also community maintained packages available for several Linux and
 BSD distributions. Please see the website, forums and wiki for details.
@@ -104,42 +97,44 @@ BSD distributions. Please see the website, forums and wiki for details.
 
 ~~~~~~~~~~~~~~~~~~~~~~ 3. Troubleshooting ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
---- In General ---
+--- General ---
 * Make sure both the hardware and software of your system match the requirements
 * If you cannot find what you are looking for on here please check the FAQs
-  (https://docs.megaglest.org/MG/FAQ) before contacting.
+  (https://docs.megaglest.org/MG/FAQ) before contacting the developers.
 
 --- Compiling ---
-* If CMake fails make sure you have read all of section 2.1 above.
+* If CMake reports that it cannot find some of the libraries, make sure that 
+  the relevant ...-dev(el) packages are also installed (distro-dependent).
 
---- Sound/Audio errors when starting ---
+--- Sound/Audio ---
 * If the game doesn't start because of audio/sound errors:
   Make sure no other application is using your soundcard. Typical problems are
   the Gnome/KDE sound dameons esd and artsd. You can kill these daemons with
-  	killall esd ; killall artsd
+  the following commands:
+  	# killall esd ; killall artsd
 
-* If this doesn't solve your sound problems try to get an updated OpenAL from
+* If this doesn't solve the sound problems, get an updated OpenAL from
   http://openal.org or a newer repository provided by your distribution.
 
-* Sound is played through OpenAL - you might need to take a look at your
+* Sound is played through OpenAL - double-check the OpenAL system 
   configuration: http://supertux.lethargik.org/wiki/OpenAL_Configuration
 
---- The game complains about OpenGL 1.3 not available, is missing OpenGL extensions
+--- OpenGL  ---
-    or works very slowly ---
+* If the game produces error messages regarding OpenGL or OpenGL extensions
-* Look at glxinfo and make sure the system is using the drivers you want to
+  being unavailable, look at glxinfo and make sure the system is using the 
-  use. If you have a NVIDIA or AMD/ATI graphics card then consider using the
+  drivers you want to use. If you have a NVIDIA or AMD/ATI graphics card then 
-  proprietary drivers (where available), which usually provide much better 
+  consider using the proprietary drivers, which may provide better 
   performance than the open source drivers most distributions use by default.
   Most Intel graphics chips use an open source driver on Linux, based on Mesa
   ("glxinfo | grep -i mesa"). This hardware is much slower than any dedicated
   graphics cards produced during the past few years. The same holds true for
-  AMD APUs, the graphics chips embedded into AMD processors.
+  AMD APUs (the graphics chips embedded into AMD processors).
 
---- The game crashes ---
+--- Crashing ---
 * Check the forums at http://forums.megaglest.org/
-* It would be nice if you could report any crashes and freezes that are not yet
+* Please report any crashes and freezes that are not yet described on the forums, 
-  described on the forums, preferably with a gdb backtrace from a debugging 
+  preferably with a gdb backtrace from a debugging enabled build 
-  enabled build (cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo)
+  (cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo)
 
 
 ~~~~~~~~~~~~~~~~~~~~~~~~~~ 4. More information ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~