Skip to content

Commit b1cf6f3

Browse files
committed
Correct, update and edit Docs/ReadMe.txt
1 parent 9d1311b commit b1cf6f3

File tree

1 file changed

+32
-30
lines changed

1 file changed

+32
-30
lines changed

Docs/ReadMe.txt

Lines changed: 32 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,15 @@ Installation
4848
================================================================================
4949

5050
CodeSnip requires Windows 2000 or later. It also requires MS Internet Explorer 6
51-
or later, but IE 8, 9 or 10 are strongly recommended.
51+
or later, although IE 8, 9 or 10 are strongly recommended. But note that recent
52+
releases have only been tested on Windows 10/11.
5253

5354
Installing the Standard Edition
5455
-------------------------------
5556

5657
You will need administrator privileges to run the setup program for the standard
5758
edition. If you are using a non-admin user account on Windows 2000 or XP you
58-
should run setup as administrator. By default Windows Vista to Windows 10 will
59+
should run setup as administrator. By default Windows Vista to Windows 11 will
5960
require an admin password if running as a standard user and setup will attempt
6061
to elevate the process. If UAC prompts are disabled you must run setup as
6162
administrator.
@@ -66,8 +67,8 @@ usual way. Uninstalling v3 or earlier after installing v4 will have no adverse
6667
affect on v4.
6768

6869
CodeSnip's installation program is named codesnip-setup-4.x.x.exe, where x.x
69-
is the program's minor version number. The install program may be distributed in
70-
a zip file.
70+
is the program's minor version number. The install program is distributed in a
71+
zip file.
7172

7273
Close any running instance of CodeSnip, run the install program then follow the
7374
on-screen instructions.
@@ -80,9 +81,9 @@ The installer makes the following changes to your system:
8081
+ Files required by the uninstaller are stored in the main installation's Uninst
8182
sub-folder.
8283

83-
+ The program's uninstall information is registered with the "Apps and Features"
84-
(a.k.a. "Programs and Features", a.k.a. "Add / Remove Programs") control panel
85-
applet.
84+
+ The program's uninstall information is registered with the "Installed App"
85+
(a.k.a. "Apps and Features", a.k.a. "Programs and Features", a.k.a. "Add /
86+
Remove Programs") control panel app.
8687

8788
+ A program group may be created in the start menu (optional).
8889

@@ -113,9 +114,10 @@ the program executable, the help file and various documentation files.
113114

114115
Install the program using the following steps:
115116

116-
1) Mount the storage medium on which you want to install CodeSnip.
117+
1) Mount any storage medium on which you want to install CodeSnip.
117118

118-
2) Create a folder on the storage medium in which to copy the required files.
119+
2) Create a folder on the storage medium or on your computer's internal disk in
120+
which to copy the required files.
119121

120122
3) Copy the files CodeSnip-p.exe (the executable program) and CodeSnip.chm
121123
(the help file) into the folder you created.
@@ -143,12 +145,13 @@ Uninstallation
143145
Uninstalling the Standard Edition
144146
---------------------------------
145147

146-
CodeSnip can be uninstalled via "Apps and Features" (a.k.a. "Programs and
147-
Features", a.k.a. "Add / Remove Programs") from the Windows Control Panel or by
148-
choosing "Uninstall DelphiDabbler CodeSnip" from the program's start menu group.
148+
CodeSnip can be uninstalled via "Installed Apps" (a.k.a. "Apps and Features",
149+
a.k.a. "Programs and Features", a.k.a. "Add / Remove Programs") accessed from the
150+
Windows Control Panel or by choosing "Uninstall DelphiDabbler CodeSnip" from the
151+
program's start menu group.
149152

150153
Administrator privileges will be required to uninstall CodeSnip. Windows Vista
151-
to Windows 10 with UAC prompts enabled will prompt for an admin password if
154+
to Windows 11 with UAC prompts enabled will prompt for an admin password if
152155
necessary.
153156

154157
The uninstall program will delete any local copy of the online Code Snippets
@@ -205,12 +208,15 @@ Windows 32 version of Delphi (from Delphi 2 to Delphi 11.x Alexandria) and
205208
FreePascal, providing some simple rules are followed.
206209

207210
When CodeSnip is first installed it knows nothing about the available compilers
208-
and so test compilations cannot be performed. You must tell CodeSnip about the
209-
available compilers by using the "Tools | Configure Compilers" menu option. The
210-
resulting dialogue can automatically detect all installed versions of supported
211-
Delphi compilers at the click of a button. Free Pascal, where installed, must be
212-
set up manually. The Welcome page displays a list of compilers it has been
213-
configured to work with.
211+
and so test compilations cannot be performed. If any supported Delphi compiler
212+
is detected when the program is first run you will be given the option of
213+
registering it. This does not work for Free Pascal.
214+
215+
You can also tell CodeSnip about the available compilers by using the "Tools |
216+
Configure Compilers" menu option. The resulting dialogue can automatically
217+
detect all installed versions of supported Delphi compilers at the click of a
218+
button. Free Pascal, where installed, must be set up manually. The Welcome page
219+
displays a list of compilers it has been configured to work with.
214220

215221
Compilers that do not use English as their output language will need further
216222
configuration. See the help file for information (look up "configure compilers
@@ -221,19 +227,16 @@ Each user can configure compilers differently.
221227
Delphi XE2 and later may need to be configured to search for required units in
222228
the correct namespaces. This is explained in the Add/Edit Snippet Dialogue Box
223229
help topic and in the FAQ at
224-
https://github.com/delphidabbler/codesnip-faq/blob/master/UsingCodeSnip.md#faq-1
230+
https://github.com/delphidabbler/codesnip-faq/blob/master/UsingCodeSnip.md#faq-7
225231

226232
Any type of snippet other than "freeform" can be test compiled.
227233

228234

229235
Updating the Program
230236
================================================================================
231237

232-
Updates are published on:
233-
234-
+ GitHub: https://github.com/delphidabbler/codesnip/releases
235-
236-
+ SourceForge: https://sourceforge.net/projects/codesnip/files/
238+
Updates are published on GitHub. See
239+
https://github.com/delphidabbler/codesnip/releases
237240

238241
News of new updates is published on the CodeSnip Blog:
239242
https://codesnip-app.blogspot.com/.
@@ -324,9 +327,8 @@ If you wish to report a bug, please check the current reports on the bug
324327
tracker. If your bug hasn't already been reported or fixed please add a report
325328
using the "Add new" link on Tracker.
326329

327-
Please note that version 4.15.1 and earlier are no longer supported, so don't
328-
report bugs for those versions. You should update the program first and only
329-
report the bug if it is still present.
330+
Please ensure that you have installed the latest version of CodeSnip and checked
331+
if the bug is still present before reporting it.
330332

331333

332334
Feedback
@@ -378,8 +380,8 @@ Thanks to:
378380

379381
+ Various contributors to the DelphiDabbler Code Snippets database. Names of
380382
contributors are listed in the program's About Box (use the "Help | About"
381-
menu option then select the "About the Database" tab). If the list is empty
382-
then updating the Code Snippets Database will download the details.
383+
menu option then select the "About the Database" tab). The list will be empty
384+
if the Code Snippets Database has not been installed.
383385

384386

385387
================================================================================

0 commit comments

Comments
 (0)