Switch the README to markdown

README → README.md

@@ -1,4 +1,4 @@
-moc-ng:  a replacement for Qt's moc that is using clang libraries
+# moc-ng:  a replacement for Qt's moc that is using clang libraries
 
 This is really two project:
 
@@ -10,25 +10,25 @@ This is really two project:
 
 Read the blog post:  https://woboq.com/blog/moc-with-clang.html
 
-BROWSE SOURCE CODE ONLINE:
+## Browse the source code online
 https://code.woboq.org/mocng/src/
 
-COMPILE:
+## Compile
 
 You need llvm and clang (3.4, 3.5 or 3.6).
 Then run cmake and make (adapt your paths)
 
  cmake . -DCMAKE_CXX_COMPILER=/opt/llvm/bin/clang++  -DLLVM_CONFIG_EXECUTABLE=/opt/llvm/bin/llvm-config
  make
 
-USE:
+## Use
 
  * As a binary:  replace the moc provided by Qt by the one which is in src/moc
 
  * As a clang plugin: Tell your build system not to run moc, and add this to the CXXFLAGS
     -Xclang -load  -Xclang /path/to/src/libmocng_plugin.so -Xclang -add-plugin -Xclang moc
 
-DIFFERENCES WITH UPSTREAM moc:
+## Differences with upstream moc
 
 This version of moc has nice additional support compared to upstream moc:
 
@@ -41,18 +41,16 @@ This version of moc has nice additional support compared to upstream moc:
 Not supported:
  * OSX Framework options (-F)
 
-PROBLEMS?
+## Problems?
 
 Make sure that the Qt include paths (and other include paths) are correctly passed to moc via the -I option
 
 Report bugs on github: https://github.com/woboq/moc-ng/issues
 
-TESTS:
+## Tests
 
 Replace the moc binary in the builddir (qtbase/bin/moc)  and run the Qt tests.
 Expecially the tst_moc and the tests for corelib/kernel.
-The tests that are known to fail are worked arounded in "workaroundtests.cpp".
+The tests that are known to fail are worked around in "workaroundtests.cpp".
 Tests for features not supported by normal Qt (such as templates) are found in
-the tests subdirectory.
-
-
+the tests subdirectory.