From f6b8194dec4e7b979064ca7fd432cd1319200348 Mon Sep 17 00:00:00 2001
From: plyatov <Unknown>
Date: Thu, 8 Nov 2007 20:38:30 +0000
Subject: [PATCH] Comments added in to the root CMakeLists.txt.

---
 CMakeLists.txt | 17 +++++++++++++++--
 install.txt    |  8 ++++----
 2 files changed, 19 insertions(+), 6 deletions(-)

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 0c580754c6..e296baf554 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -1,11 +1,17 @@
+# Our project is called 'kicad' this is how it will be called in
+# visual studio, and in our makefiles. 
 PROJECT(kicad)
 
 CMAKE_MINIMUM_REQUIRED(VERSION 2.4 FATAL_ERROR)
 
 #SET(CMAKE_VERBOSE_MAKEFILE ON)
 
+# Here you can define what libraries of wxWidgets you need for your
+# application. You can figure out what libraries you need here;
+# http://www.wxwidgets.org/manuals/2.8/wx_librarieslist.html
 SET(wxWidgets_USE_LIBS base core adv gl html net)
 
+# We need the Find package for wxWidgets to work.
 FIND_PACKAGE(wxWidgets REQUIRED)
 
 #Locations for install targets
@@ -28,11 +34,17 @@ ENDIF(WIN32)
 IF(APPLE)
 ENDIF(APPLE)
 
+# Did we find wxWidgets ? This condition will fail
+# for as long as the internal vars do not point to
+# the proper wxWidgets configuration.
 IF(wxWidgets_FOUND)
 	MESSAGE("-- wxWidgets found")
 	
-	INCLUDE(${wxWidgets_USE_FILE})
+	# Include wxWidgets macros.
+        INCLUDE(${wxWidgets_USE_FILE})
 
+        # We define the include paths here, our source dirs 
+        # and also the include dirs defined by wxWidgets.
 	INCLUDE_DIRECTORIES(
 		${CMAKE_CURRENT_SOURCE_DIR}/include
 		${CMAKE_CURRENT_SOURCE_DIR}/share)
@@ -45,7 +57,8 @@ IF(wxWidgets_FOUND)
 	ADD_SUBDIRECTORY(kicad)
 	ADD_SUBDIRECTORY(pcbnew)
 ELSE(wxWidgets_FOUND)
-	MESSAGE("wxWidgets is required to build KiCad!")
+        # For convenience. When we cannot continue, inform the user.
+        MESSAGE("wxWidgets is required to build KiCad!")
 ENDIF(wxWidgets_FOUND)
 
 ADD_SUBDIRECTORY(internat)
diff --git a/install.txt b/install.txt
index 8d153d182f..84f20634bd 100644
--- a/install.txt
+++ b/install.txt
@@ -88,11 +88,11 @@ Archive and doc files (Linux and windows ) are in ../kicad/wing3d
 goto www.wings3d.org to have more details.
 Pcbnew use the exported files in wrml (.wrl) format from wings3d (not the native .wings format).
 
-Documentation:
-Currenty only in french.
+== Documentation: ==
+Currenty not only in french.
 "On line" in html format.
-source files (200 sheets) are in OpenOffice (www.openoffice.org) format.
-Can be read, printed and/or modified with OpenOffice.
+Source files (200 sheets) are in OpenOffice.org (www.openoffice.org) format.
+Can be read, printed and/or modified with OpenOffice.org Writer.
 See files in kicad/help/doc_src/*
 
 KiCad tree: