Convert Readme to markdown format
authorMarco Costalba <mcostalba@gmail.com>
Sat, 23 Feb 2013 16:00:33 +0000 (17:00 +0100)
committerMarco Costalba <mcostalba@gmail.com>
Sat, 23 Feb 2013 16:05:28 +0000 (17:05 +0100)
Looks better on GitHub, that supports this format.

No functional change.

Readme.md [moved from Readme.txt with 73% similarity]

similarity index 73%
rename from Readme.txt
rename to Readme.md
index 9c80a87..9fd242d 100644 (file)
+++ b/Readme.md
@@ -1,5 +1,4 @@
-1. Introduction
----------------
+### Overview
 
 Stockfish is a free UCI chess engine derived from Glaurung 2.1. It is
 not a complete chess program and requires some UCI-compatible GUI
@@ -13,41 +12,36 @@ tested thoroughly with more than 4.  The program tries to detect the
 number of CPUs on your computer and sets the number of search threads
 accordingly, but please be aware that the detection is not always
 correct. It is therefore recommended to inspect the value of the
-"Threads" UCI parameter, and to make sure it equals the number of CPU
+*Threads* UCI parameter, and to make sure it equals the number of CPU
 cores on your computer. If you are using more than eight threads, it is
-recommended to raise the value of the "Min Split Depth" UCI parameter to
-7.
+recommended to raise the value of the *Min Split Depth* UCI parameter to 7.
 
 
-2. Files
---------
+### Files
 
 This distribution of Stockfish consists of the following files:
 
-  * Readme.txt, the file you are currently reading.
+  * Readme.md, the file you are currently reading.
 
   * Copying.txt, a text file containing the GNU General Public License.
 
-  * src/, a subdirectory containing the full source code, including a
-    Makefile that can be used to compile Stockfish on Unix-like systems.
-    For further information about how to compile Stockfish yourself read
-    section 4 below.
+  * src/, a subdirectory containing the full source code, including a Makefile
+    that can be used to compile Stockfish on Unix-like systems. For further
+    information about how to compile Stockfish yourself read section below.
 
   * polyglot.ini, for using Stockfish with Fabien Letouzey's PolyGlot
     adapter.
 
 
-3. Opening books
-----------------
+### Opening books
 
 This version of Stockfish has support for PolyGlot opening books. For
 information about how to create such books, consult the PolyGlot
-documentation. The book file can be selected by setting the "Book File"
+documentation. The book file can be selected by setting the *Book File*
 UCI parameter.
 
 
-4. Compiling it yourself
-------------------------
+### Compiling it yourself
 
 On Unix-like systems, it should be possible to compile Stockfish
 directly from the source code with the included Makefile.
@@ -55,17 +49,16 @@ directly from the source code with the included Makefile.
 Stockfish has support for 32 or 64-bit CPUs, the hardware POPCNT
 instruction, big-endian machines such as Power PC, and other platforms.
 
-In general it is recommended to run 'make help' to see a list of make
+In general it is recommended to run `make help` to see a list of make
 targets with corresponding descriptions. When not using Makefile to
 compile (for instance with Microsoft MSVC) you need to manually
-set/unset some switches in the compiler command line; see file "types.h"
+set/unset some switches in the compiler command line; see file *types.h*
 for a quick reference.
 
 
-5. Terms of use
----------------
+### Terms of use
 
-Stockfish is free, and distributed under the GNU General Public License
+Stockfish is free, and distributed under the **GNU General Public License**
 (GPL). Essentially, this means that you are free to do almost exactly
 what you want with the program, including distributing it among your
 friends, making it available for download from your web site, selling
@@ -78,4 +71,4 @@ to where the source code can be found. If you make any changes to the
 source code, these changes must also be made available under the GPL.
 
 For full details, read the copy of the GPL found in the file named
-Copying.txt.
+*Copying.txt*