updated readme.txt

readme.txt

@@ -5,49 +5,85 @@ Cppcheck
 
 About
 
-  The original name of this program is "C++check".
+    The original name of this program is "C++check" but it was later changed to "cppcheck".
-  The name was changed to "cppcheck".
 
 
 Compiling
 
-  Any C++ compiler should work.
+    Any C++ compiler should work.
-
+
-  The Makefile works under Linux.
+    To build the GUI, you need Qt. The command line tool doesn't have any dependencies.
-  To make it work under Windows with DJGPP, change "g++" to "gxx".
+
-
+    There are multiple compilation choices:
-  To build cppcheck with qmake, run these commands:
+      * SCons - cross platform build tool
-  
+      * CMake - cross platform build tool
-   Generate Makefile (use 'debug' instead of 'release' if doing developer build)
+      * qmake - cross platform build tool - but only the GUI can be built
-   (If you are using Mac OS, you need to add "-spec macx-g++" to the command):
+      * Visual Studio - Windows
-     qmake -config release
+      * gnu make (for experts)
-    
+      * g++ (for experts)
-   Build command-line tool, GUI and autotests:
+
-     make
+
-
+    Scons
-   To build command-line tool only:
+    =====
-     make sub-src 
+        Scons is a multi platform build tool. Python is required to run it.
-    
+            scons
-   To build and run autotests:
+
-     make check
+
-
+    CMake
+    =====
+        CMake is a multi platform build tool with no dependencies.
+            cmake .
+            make
+
+
+    qmake
+    =====
+        You can use the gui/gui.pro file to build the gui.
+            cd gui
+            qmake
+            make
+
+
+    Visual Studio
+    =============
+        Use the cppcheck.sln file.
+
+
+    gnu make (for experts)
+    ======================
+        A simple Makefile generator is available and you can use it like this:
+            g++ -o dmake tools/dmake.cpp lib/filelister.cpp
+            ./dmake
+
+        The generated Makefile may need to be edited to fit your needs.
+        If it doesn't work, unfortunately we can't help you.
+
+
+    g++ (for experts)
+    =================
+        If you just want to build Cppcheck then you can use this command:
+            g++ -o cppcheck -Ilib cli/*.cpp lib/*.cpp
+
+        If it doesn't work, unfortunately we can't help you.
+
+
 Cross compiling Win32 (CLI) version of Cppcheck in Linux
 
-  sudo apt-get install mingw32
+    sudo apt-get install mingw32
-  make CXX=i586-mingw32msvc-g++ LDFLAGS="-lshlwapi"
+    make CXX=i586-mingw32msvc-g++ LDFLAGS="-lshlwapi"
-  mv cppcheck cppcheck.exe
+    mv cppcheck cppcheck.exe
 
 Usage
 
-  Run the cppcheck program without parameters and a help text will be shown.
+    Run the cppcheck program without parameters and a help text will be shown.
 
 
 Recommendations
 
-  When the "--all" flag is given you may get a lot of error messages.
+    When the "--all" flag is given you may get a lot of error messages.
 
 
 Webpage
 
-  http://www.sf.net/projects/cppcheck
+    http://www.sf.net/projects/cppcheck