docs: various updates and fixes from Reinier

git-svn-id: http://svn.freepascal.org/svn/lazarus/trunk@42502 4005530d-fff6-0310-9dd1-cebe43e6787f

README.txt

@@ -7,14 +7,14 @@ independent visual components like buttons, windows, checkbox, treeview and
 many, many more. The LCL is platform independent, so you can write an
 application once and then compile for various platforms without changing code.
 
-Free Pascal at www.freepascal.org is a fast object pascal compiler (and more),
-that runs on more than 20 platforms (linux, windows, BSD, OS/2, DOS, PowerPC,
+Free Pascal at www.freepascal.org is a fast Object Pascal compiler (and more),
+that runs on more than 20 platforms (Linux, Windows, BSD, OS/2, DOS, PowerPC,
 and many more).
 
-The LCL currently supports linux (gtk, gtk2 and qt4), all flavours of windows,
-even wince, Mac OS X (carbon, gtk, qt4), FreeBSD (gtk, gtk2).
-There is experimental support for Solaris and the native pascal backend fpgui
-which runs on windows, wince and linux.
+The LCL currently supports Linux (gtk, gtk2 and qt4), all flavors of Windows
+(even wince), Mac OS X (carbon, gtk, qt4), FreeBSD (gtk, gtk2).
+There is experimental support for Solaris and the native Pascal backend fpgui
+which runs on Windows, Wince and Linux.
 
 --------------------------------------------------------------------------------
 Compilation:
@@ -24,10 +24,10 @@ You don't need ./configure, just do
 
 (BSD users: gmake clean bigide)
 
-This will create the lazarus executable with a lot of packages.
+This will create the Lazarus executable with a lot of packages.
 Start it and enjoy.
 
-If the above gives an error you can try to build a minimal IDE with
+If the above gives an error, you can try to build a minimal IDE with
   []$ make clean all
 
 (BSD users: gmake clean all)
@@ -49,22 +49,23 @@ Documentation:
 
 The official site is www.lazarus.freepascal.org. There you can find the FAQ -
 the frequently asked questions.
-Documents about specific topics can be found at lazarus-ccr.sourceforge.net.
-Examples, how to use the LCL can be found in the 'examples' directory.
+Documents about specific topics can be found at 
+wiki.freepascal.org/Lazarus_Documentation.
+Examples on how to use the LCL can be found in the 'examples' directory.
 Help, documents and files about Free Pascal are at www.freepascal.org.
 
 
 --------------------------------------------------------------------------------
 Mailing list:
 
-There is a very active and helpful mailing list for lazarus, where the
+There is a very active and helpful mailing list for Lazarus, where the
 developers interact, share ideas, discuss problems, and of course answer
 questions.
 You can subscribe at
 http://lists.lazarus.freepascal.org/mailman/listinfo/lazarus
 
 --------------------------------------------------------------------------------
-How to help lazarus:
+How to help Lazarus:
 
 If you find bugs, don't hesitate to use the bug tracking tool at the website,
 or send an email to the list.

components/README.txt

@@ -22,8 +22,8 @@ customform
   Registering custom form descendants in the IDE.
 
 daemon
-  Package to create programs that run as daemon under linux or service under
-  windows.
+  Package to create programs that run as daemon under Linux or service under
+  Windows.
 
 datadict
   Support for data dictionaries for the IDE and applications.
@@ -41,7 +41,7 @@ filebrowser
   A file browser window for the IDE.
 
 fpcunit
-  template for a fpcunit gui test runner
+  Template for a fpcunit GUI test runner.
 
 fpweb
   Units that support web server and web client programming.
@@ -65,7 +65,7 @@ lazthread
    ?
 
 leakview
-  Extends the IDE with a graphical viewer for the heaptrc output.
+  Extends the IDE with a graphical viewer for heaptrc output.
 
 pochecker
   Validates translated PO files.
@@ -89,7 +89,7 @@ opengl
   An OpenGL control.
 
 paradox
-  Support for paradox databases.
+  Support for Paradox databases.
 
 PascalScript
   Version of RemObjects Pascal Script adapted for use in the Lazarus IDE.
@@ -130,7 +130,7 @@ synedit
   The text editor control used by the IDE.
 
 synunihighlighter
-  An universal highlighter for synedit.
+  A universal highlighter for synedit.
 
 tachart
   A control for graphs and plots.

docs/BigIDE.txt

@@ -15,7 +15,7 @@ components/Makefile.fpc   package directories
 ide/lazarus.pp            package names
 
 
-Do not forget update the ide/Makefile and components/Makefile.
+Do not forget to update the ide/Makefile and components/Makefile.
 
 Compiling the bigide:
 

docs/CrossCompile.txt

@@ -1,4 +1,4 @@
-Hints to cross compile under linux/xxxBSD
+Hints to cross compile under Linux/xxxBSD
 =========================================
 
 
@@ -7,24 +7,26 @@ Thanks to Vincent Snijders for the hints.
 ================================================================================
 
 A.
-for fpc 2.0 and up. On linux and bsd to other platforms like windows.
+For FPC 2.0 and up. On Linux and BSD to other platforms.
+(Note: not necessary for cross-compiling to Windows as FPC has had an internal 
+linker for this platform).s
 
 Abstract:
-  The following describes how to setup the binutils, fpc and lazarus for
+  The following describes how to setup the binutils, FPC and Lazarus for
   crosscompiling to other targets. Once you have these cross files you can
   switch easily in the Lazarus IDE between any of the target platforms.
 
 IMPORTANT: The FPC units must have the same date/version for all platforms,
   because you will use only one compiler. That means:
-  Whenever you update your FPC, you must update all other cross fpc units too.
-  The scripts will help you doing this.
+  Whenever you update your FPC, you must update all other cross FPC units too.
+  The scripts will help you to do this.
 
  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 
 A.1
 
 Requirements:
-  An installed and working fpc. Preferrably the latest stable release.
+  An installed and working fpc. Preferably the latest stable release.
   A good internet connection or manually downloaded FPC sources and binutils.
 
 The following steps don't need the root user. They can be done as normal user.
@@ -77,13 +79,13 @@ TODO: write, where you can get the fpc 'install' directory sources.
 
 ================================================================================
 
-What the lazarus scripts do / Doing it by hand:
+What the Lazarus scripts do / Doing it by hand:
 
 
-1. Download the fpc sources
+1. Download the FPC sources
 
-  IMPORTANT: Your current FPC must be the same version/date as the fpc sources.
-  If your installed fpc is different, you can compile a new fpc from the
+  IMPORTANT: Your current FPC must be the same version/date as the FPC sources.
+  If your installed FPC is different, you can compile a new FPC from the
   sources.
 
 
@@ -127,7 +129,7 @@ What the lazarus scripts do / Doing it by hand:
 
 3. Cross build binutils
 
-  In the fpc source directory there is a script to build the binutils for all
+  In the FPC source directory there is a script to build the binutils for all
   cross platforms: install/cross/buildcrossbinutils
   Create a copy of the script:
 
@@ -151,7 +153,7 @@ What the lazarus scripts do / Doing it by hand:
   The script will automatically combine this to ~/download/binutils-2.14.tar.gz.
   The other variables define what target platforms you have. The default is to
   build quite a lot, so compilation will take some time (hours).
-  For cross compile to windows, you need only
+  For cross compile to Windows, you need only
 
   TARGETS_WIN="mingw32"
 
@@ -175,9 +177,9 @@ What the lazarus scripts do / Doing it by hand:
   without failed targets.
 
 
-4. Cross build fpc
+4. Cross build FPC
 
-  In the fpc source directory there is a script to build the fpc snapshot for
+  In the FPC source directory there is a script to build the FPC snapshot for
   all cross platforms: install/cross/buildcrosssnapshot
   Create a copy of the script:
 
@@ -204,7 +206,7 @@ What the lazarus scripts do / Doing it by hand:
 
   []$ sh buildcrosssnapshot.sh
 
-  This will create the fpc binaries under
+  This will create the FPC binaries under
   ~/freepascal/binutils/cross/destination/.
 
 

docs/DesignGuidelines.txt

@@ -1,26 +1,26 @@
-This is for lazarus developers:
+This is for Lazarus developers:
 
 Coding style:
 - Since one style is easier to read, Lazarus follows the Borland Coding style
-  guide lines. Of course, almost anyone will find some points there, that are
-  arguable less readable than other styles. That's ok, just try to follow at
+  guidelines. Of course, almost anyone will find some points there, that are
+  arguably less readable than other styles. That's OK, just try to follow at
   least 90%.
-- Try to avoid unit circles. This makes it easier to navigate and when unit is
-  growing allows to split it.
+- Try to avoid unit circles. This makes it easier to navigate and allows to
+  split the unit when it is growing.
 - Minimize the number of calls from Interfaces to LCL, when performing an
   action requested by the LCL. The interfaces only notify the LCL, never forces
   something. The LCL decides.
   Naming convention:
     Notifications for TControl decendants should be named CNxxx.
 - All code must work with all checks (range, io, overflow, stack) on. Beside
   that this helps debugging, some users put these checks into their fpc.cfg, so
-  they are applied to whole lazarus. Including packages and examples.
+  they are applied to whole Lazarus. Including packages and examples.
 
 
 New files:
 - Every file should start with a header containing the license and a few lines
   describing the content.
-- pascal sources should have lowercase filenames (.pas, .pp, .inc, .lfm, .lrs)
+- Pascal sources should have lowercase filenames (.pas, .pp, .inc, .lfm, .lrs)
 
 Include files:
 - should start with the {%MainUnit } directive

docs/ExtendingTheIDE.txt

@@ -1,7 +1,7 @@
 Extending the IDE (Overview)
 ============================
 
-The online pages are more uptodate and have more examples:
+The online pages are more up to date and have more examples:
 http://wiki.lazarus.freepascal.org/Extending_the_IDE
 
 

docs/ForDelphians.txt

@@ -1,24 +1,24 @@
-This text is for people knowing Delphi and it describes the differences.
+This text is for people who know Delphi; it describes differences with Delphi.
 
-The online document is more uptodate:
+The online document is more up to date:
 http://wiki.lazarus.freepascal.org/Lazarus_Documentation#Coming_from_Delphi
 
 
 Delphi -> Lazarus
 =================
 
 Lazarus is an Rapid Application Development (RAD) tool like Delphi. That means
-it comes with a visual component library and an IDE. The lazarus component
+it comes with a visual component library and an IDE. The Lazarus component
 library (LCL) is very similar to Delphi's VCL. Most units, classes and
 properties have the same name and functionality. This makes porting easy. But
 Lazarus is *not* an 'open source Delphi clone'. So don't expect 100%
 compatibility.
 
 The biggest differences:
 Lazarus is completely open source, is written platform independent and uses the
-mighty FreePascal compiler (FPC). FPC runs on more than 15 platforms. But not
-all packages and libs are ported, so Lazarus currently runs on Linux,
-Free/Open/NetBSD and the win32 port is under heavy development.
+mighty FreePascal compiler (FPC). FPC runs on more than 15 platforms. However, 
+not all packages and libs are ported, so Lazarus currently runs on Linux,
+Free/Open/NetBSD and win32.
 
 Lazarus is not complete, as is this text. We are always searching for new
 developers, packagers, porters, documentation writers, ... .