Updated read-me re changes to be included in v4.16.0 & some other minor changes

Author: delphidabbler

Docs/ReadMe.txt

@@ -15,7 +15,7 @@ user-defined snippets.
 
 It displays details of each snippet in the database and can test-compile them
 with each installed Win32 version of Delphi from Delphi 2 to Delphi 10.1 Berlin
-along with Free Pascal.
+and Free Pascal.
 
 Compilable Pascal units can be created that contain selected snippets.
 
@@ -33,8 +33,9 @@ There are two different editions of CodeSnip 4 available:
   the system's application and user data directories.
 
 + The portable edition that can be run from any writeable removable storage
-  medium (e.g. a USB memory stick) that makes no changes to the host computer.
-  This edition has no installer and is simply copied onto the required medium.
+  medium (e.g. a USB memory stick) and that makes no changes to the host
+  computer. This edition has no installer and is simply copied onto the required
+  medium.
 
 You can run both the standard and portable editions together on the same
 computer and even run them at the same time. However, each edition maintains its
@@ -46,15 +47,15 @@ other. CodeSnip provides no mechanism for keeping them synchronised.
 Installation
 ================================================================================
 
-CodeSnip requires Windows 2000 or later. It also requires MS Internet Explorer
-V6 or later, but IE 8, 9 or 10 are strongly recommended.
+CodeSnip requires Windows 2000 or later. It also requires MS Internet Explorer 6
+or later, but IE 8, 9 or 10 are strongly recommended.
 
 Installing the Standard Edition
 -------------------------------
 
 You will need administrator privileges to run the setup program for the standard
 edition. If you are using a non-admin user account on Windows 2000 or XP you
-should run setup as administrator. By default Windows Vista and Windows 7 will
+should run setup as administrator. By default Windows Vista to Windows 10 will
 require an admin password if running as a standard user and setup will attempt
 to elevate the process. If UAC prompts are disabled you must run setup as
 administrator.
@@ -79,15 +80,15 @@ The installer makes the following changes to your system:
 + Files required by the uninstaller are stored in the main installation's Uninst
   sub-folder.
 
-+ The program's uninstall information is registered with the "Programs and
-  Features" (a.k.a. "Add / Remove Programs") control panel applet.
++ The program's uninstall information is registered with the "Apps and Features"
+  (a.k.a. "Programs and Features", a.k.a. "Add / Remove Programs") control panel
+  applet.
 
 + A program group may be created in the start menu (optional).
 
 + A %ProgramData%\DelphiDabbler\CodeSnip.4 folder is created. A configuration
-  file is stored in the folder. If the online database is downloaded, it will be
-  stored in a "Database" sub-folder, unless you have changed the database
-  location (see below).
+  file is stored in the folder. If the online database is installed, it will be
+  copied to the "Database" sub-folder.
 
 + An %AppData%\DelphiDabbler\CodeSnip.4 folder is also created. This is used to
   hold a file that stores per-user configuration data and, sometimes, another
@@ -114,21 +115,22 @@ Install the program using the following steps:
 
 1) Mount the storage medium on which you want to install CodeSnip.
 
-2) Create a folder on the storage medium in which to "install" CodeSnip.
+2) Create a folder on the storage medium in which to copy the required files.
 
 3) Copy the files CodeSnip-p.exe (the executable program) and CodeSnip.chm
    (the help file) into the folder you created.
 
    CodeSnip does not need the other files included in the zip file in order to
    run, but you may find them useful. Copy them if you wish.
 
-Run the program by double clicking it. When it first runs it will created two
+Run the program by double clicking it. When it first runs it will create two
 sub-directories within the folder where you installed the program. These will
 be named AppData and UserData. Do not remove these directories or alter any of
 the contents. CodeSnip uses them to store configuration data along with your
 code snippets.
 
-No files are written to the host computer and the registry is not modified.
+No files are written outside the folder where you copied the files and the
+registry is not modified.
 
 
 Uninstallation
@@ -137,12 +139,11 @@ Uninstallation
 Uninstalling the Standard Edition
 ---------------------------------
 
-CodeSnip can be uninstalled via "Programs and Features" (a.k.a. "Add/Remove
-Programs") from the Windows Control Panel or by choosing "Uninstall
-DelphiDabbler CodeSnip" from the program's start menu group.
+CodeSnip can be uninstalled via "Apps and Features" (a.k.a. "Programs and
+Features", a.k.a. "Add / Remove Programs") from the Windows Control Panel or by choosing "Uninstall DelphiDabbler CodeSnip" from the program's start menu group.
 
 Administrator privileges will be required to uninstall CodeSnip. Windows Vista
-and Windows 7 with UAC prompts enabled will prompt for an admin password if
+to Windows 10 with UAC prompts enabled will prompt for an admin password if
 necessary.
 
 The uninstall program will delete any local copy of the online Code Snippets
@@ -155,7 +156,7 @@ those directories also need to be deleted.
 Uninstalling the Portable Edition
 ---------------------------------
 
-Simply delete the folder where you installed CodeSnip and all its contents.
+Simply delete the folder where you installed CodeSnip, with all its contents.
 
 Be aware that any snippets you have created will be lost. If you want to keep
 them for use in another CodeSnip installation either export them or back up the
@@ -171,26 +172,13 @@ program.
 
 CodeSnip's start-up screen shows details of any installed databases. If there is
 no copy of the online database a link is displayed that enables the database to
-be installed.
+be installed. This link opens the "Install or Update DelphiDabbler Snippets
+Database" wizard style dialogue box. The dialogue box explains how to download
+and install the database.
 
-By default CodeSnip checks online periodically to find out whether the database
-has been updated. The checking process runs behind the scenes unless an update
-is available when CodeSnip will display a notification window at the bottom
-right of the main window. From the window you can display the "Update From Web"
-dialogue which you can use to download the updated database.
-
-You can also check for updates manually by using the program's "Database |
-Update From Web" menu option. This displays the same "Update From Web" dialogue
-box mentioned above. You can get to know about what updates are available by
-subscribing to the CodeSnip RSS feed (see below).
-
-If you don't want CodeSnip to check for database updates automatically, or if
-you want to change the frequency with with it checks, you can do that from the
-"Updates" tab of the "Preferences" dialogue box. This dialogue box is accessed
-via the "Tools | Preferences" menu option.
-
-NOTE: You may need to configure your firewall to permit CodeSnip to access the
-internet otherwise the automatic updating may not work.
+You can download or update the database later by opening the same dialogue box
+using the "Database | Install or Update DelphiDabbler Snippets Database" menu
+option.
 
 Standard Edition Only
 ---------------------
@@ -208,8 +196,8 @@ Configuring CodeSnip to Work With Your Compilers
 ================================================================================
 
 A feature of CodeSnip is its ability to test compile snippets with any installed
-Windows 32 version of Delphi and FreePascal. User defined snippets can also be
-test compiled providing some simple rules are followed.
+Windows 32 version of Delphi (from Delphi 2 to Delphi 10.1 Berlin) and
+FreePascal, providing some simple rules are followed.
 
 When CodeSnip is first installed it knows nothing about the available compilers
 and so test compilations cannot be performed. You must tell CodeSnip about the
@@ -230,24 +218,7 @@ required units in the correct namespaces. This is explained in the Add/Edit
 Snippet Dialogue Box help topic and in the FAQ at
 https://github.com/delphidabbler/codesnip-faq/blob/master/UsingCodeSnip.md#faq-1
 
-
-Registration
-================================================================================
-
-Registration of CodeSnip is not required, but the author would be grateful if
-you do register the program, just so he knows it is being used.
-
-To register click the "Tools | Register CodeSnip" menu item and follow the
-wizard. If this menu option is not displayed then the program has already been
-registered.
-
-On systems with multiple users using the standard edition, only one user needs
-to register. Once this is done the program will show as registered regardless of
-which user is logged on.
-
-When using the portable edition, uninstalling the program looses registration
-data. If the portable edition is installed on more than one device then each
-copy must be registered separately.
+Any type of snippet other than "freeform" can be test compiled.
 
 
 Updating the Program
@@ -267,25 +238,18 @@ Known Installation and Upgrading Issues
 ================================================================================
 
 + Any syntax highlighter customisation you have made will be lost if you are
-  updating from any v2 or earlier release.
+  updating from any v2 or earlier.
 
-  You will need to redo any customisation using the Syntax Highlighter tab of
+  You will need to redo any customisation using the "Syntax Highlighter" tab of
   the Preferences dialogue box displayed from the "Tools | Preferences" menu
   option.
 
 + Your source code formatting preferences will have been lost if you are
   updating from v1.7.4 or earlier.
 
-  You will need to reconfigure them using the Code Formatting tab of the
+  You will need to reconfigure them using the "Code Formatting" tab of the
   Preferences dialogue box displayed from the "Tools | Preferences" menu option.
 
-+ If you are updating from v1.8.11 or earlier and have registered CodeSnip your
-  registration information will have been lost.
-
-  You can check this by displaying the About dialogue box. If it displays a
-  Register CodeSnip button the program is not registered. You can (re)register
-  if you wish by clicking the button.
-
 + If you have updated to CodeSnip v4.2.0 or later from any earlier v4 release,
   and then run the earlier version of the program again, its saved main window
   state, size, position and layout will have been lost and the program will
@@ -296,6 +260,9 @@ Known Installation and Upgrading Issues
   tab of the Configure Compilers dialogue box for Delphi XE2 or later will be
   removed and equivalent entries will have been made on the "Namespaces" tab.
 
++ CodeSnip v4.16.0 and later cannot be registered. Any previous registration
+  information may be lost.
+
 
 License & Disclaimer
 ================================================================================
@@ -308,9 +275,17 @@ option.
 CodeSnip is supplied on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
 express or implied. See License.html for details.
 
-The source code contained in the database, or in any units or snippets generated
-by this program, is made available on an "AS IS" basis, WITHOUT WARRANTY OF ANY
-KIND, either express or implied. The code is used entirely at you own risk.
+The source code of any snippet managed by CodeSnip, whether from the
+DelphiDabbler Code Snippets Database or the user database, is used WITHOUT
+WARRANTY OF ANY KIND, either express or implied. The code is used entirely at
+the user's own risk.
+
+The snippets from the DelphiDabbler Code Snippets Database is open source. See
+the "About The Database" tab of the About dialogue box for details of the
+applicable license. (You can display the About box from the "Help" menu.)
+
+The user is responsible to ensure that any code snippets managed by CodeSnip are
+used in accordance with any applicable license.
 
 
 Source Code
@@ -334,7 +309,7 @@ Bugs
 Please do report any bugs you find.
 
 Bugs are recorded in tracker software. View the reported and fixed bugs via
-https://github.com/delphidabbler/codesnip/issues
+https://github.com/delphidabbler/codesnip/issues (GitHub account required).
 
 You can also access the bug tracker from CodeSnip by using the "Tools | Report
 Bug Online" menu option then following the link that appears in the resulting
@@ -344,7 +319,7 @@ If you wish to report a bug, please check the current reports on the bug
 tracker. If your bug hasn't already been reported or fixed please add a report
 using the "Add new" link on Tracker.
 
-Please note that versions 1 to 3 of CodeSnip are no longer supported, so don't
+Please note that version 4.15.1 and earlier are no longer supported, so don't
 report bugs for those versions. You should update the program first and only
 report the bug if it is still present.
 
@@ -354,7 +329,11 @@ Feedback
 
 If you want to suggest new features please use the feature request tracker
 accessed from https://github.com/delphidabbler/codesnip/issues (GitHub account
-required).
+required). Please check whether anyone else has requested something similar and
+add a comment to their request if so.
+
+Always check the latest version of CodeSnip before requesting a feature just in
+case it has already been implemented!
 
 
 FAQs
@@ -370,18 +349,18 @@ Thanks
 Thanks to:
 
 + David Mustard and Bill Miller for providing information that enabled me to add
-  Delphi 2007 and Delphi 2009 support respectively to the program.
+  Delphi 2007 and Delphi 2009 support, respectively, to the program.
 
 + geoffsmith82 and an anonymous contributor for information about getting
   CodeSnip to work with Delphi XE2.
 
 + The authors of the third party source code and images used by the program. See
   the program's about box or License.html for details.
 
-+ Various contributors to the Code Snippets database. Names of contributors are
-  listed in the program's About Box (use the "Help | About" menu option then
-  select the "About the Database" tab). If the list is empty then updating the
-  Code Snippets Database will download the details.
++ Various contributors to the DelphiDabbler Code Snippets database. Names of
+  contributors are listed in the program's About Box (use the "Help | About"
+  menu option then select the "About the Database" tab). If the list is empty
+  then updating the Code Snippets Database will download the details.
 
 
 ================================================================================