Skip to content

Commit 918b871

Browse files
committed
Update README.md
Minor edits Add several links
1 parent 83aee21 commit 918b871

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

Diff for: README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ CodeSnip can import code from the DelphiDabbler [Code Snippets Database](https:/
1818

1919
The program is available in both standard and portable editions.
2020

21-
CodeSnip requires Windows 2000 or later and Internet Explorer 6 or later, although XP and IE 8 and later are preferred.
21+
CodeSnip requires Windows 2000 or later and Internet Explorer 6 or later, although XP and IE 8 and later are recommended.
2222

2323
## Installation
2424

2525
The standard edition of CodeSnip is installed and removed using a standard Windows installer. Administrator privileges are required for installation.
2626

27-
The portable edition has no installer. Simply follow the instructions in the [read me file](https://github.com/delphidabbler/codesnip/blob/master/Docs/ReadMe.txt) that is included in the download zip file.
27+
The portable edition has no installer. Simply follow the instructions in the [read me file](https://raw.githubusercontent.com/delphidabbler/codesnip/master/Docs/ReadMe.txt) that is included in the download zip file.
2828

2929
## Support
3030

@@ -37,15 +37,15 @@ The following support is available CodeSnip users:
3737

3838
There's also plenty of info available on how to compile CodeSnip from source - see below.
3939

40-
<sup>*</sup> This link takes you to the most recent version of the read-me file -- it can change from release to release.
40+
> <sup>*</sup> This link takes you to the most recent version of the read-me file -- it can change from release to release.
4141
4242
## Source Code
4343

4444
CodeSnip's source code is maintained in the [`delphidabbler/codesnip`](https://github.com/delphidabbler/codesnip) Git repository on GitHub†.
4545

4646
The [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/) methodology has been adopted, with the exception of some branches that have been used in various attempts to start work on CodeSnip 5.
4747

48-
The following branches existed as of 2022/01/01:
48+
The following branches existed as of 2022/07/01:
4949

5050
* `master`: Always reflects the state of the source code as of the latest release.‡
5151
* `develop`: Main development branch. The head of this branch contains the latest v4 development code.
@@ -71,11 +71,11 @@ To contribute to CodeSnip 4 development please fork the repository on GitHub. Cr
7171

7272
The license that applies to any existing file you edit will continue to apply to the edited file. Any existing license text or copyright statement **must not** be altered or removed.
7373

74-
Any new file you contribute **must** either be licensed under the Mozilla Public License v2.0 (MPL2) or have a license compatible with the MPL2. If a license is not specified then the MPL2 will be applied to the file. You should insert a suitable copyright statement in the file.
74+
Any new file you contribute **must** either be licensed under the [Mozilla Public License v2.0](https://www.mozilla.org/MPL/2.0/) (MPL2) or have a license compatible with the MPL2. If a license is not specified then MPL2 will be assumed and will be applied to the file. You should insert a suitable copyright statement in the file.
7575

7676
Any third party code used by your contributed code **must** also have a license compatible with the MPL2.
7777

78-
> MPL2 boilerplate text, in several programming language's comment formats, can be found in the file `Docs/MPL-2.0-Boilerplate.txt`. You will need to change the name of the copyright holder.
78+
> MPL2 boilerplate text, in several programming language's comment formats, can be found in the file [`Docs/MPL-2.0-Boilerplate.txt`](https://raw.githubusercontent.com/delphidabbler/codesnip/master/Docs/MPL-2.0-Boilerplate.txt). You will need to change the name of the copyright holder.
7979
8080
### Compiling
8181

@@ -87,7 +87,7 @@ CodeSnip 4 **must** be compiled with Delphi XE. See [Compiling & Source Code FAQ
8787

8888
## Change Log
8989

90-
The program's current change log can be found in the file `CHANGELOG.md` in the root of the `master` branch.
90+
The program's current change log can be found in the file [`CHANGELOG.md`](https://github.com/delphidabbler/codesnip/blob/master/CHANGELOG.md) in the root of the `master` branch.
9191

9292
> Note that CodeSnip v4.15.1 and earlier did not have `CHANGELOG.md`. Instead, some versions maintained a separate change log for each major version in the `Docs/ChangeLogs` directory.
9393

0 commit comments

Comments
 (0)