Skip to content

Commit 8548d1d

Browse files
Update README.md
Change Source Code section re addition of caboli branch and abandonment of belvedere. Some other corrections & clarifications
1 parent ecb8c16 commit 8548d1d

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ CodeSnip requires Windows 2000 or later and Internet Explorer 6 or later, althou
2222

2323
## Installation
2424

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

2727
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

31-
The following support is available CodeSnip users:
31+
The following support is available to CodeSnip users:
3232

3333
* A comprehensive help file.
3434
* A [read-me file](https://raw.githubusercontent.com/delphidabbler/codesnip/master/Docs/ReadMe.txt)<sup> *</sup> that discusses installation, configuration, updating and known issues.
@@ -43,19 +43,17 @@ There's also plenty of info available on how to compile CodeSnip from source - s
4343

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

46-
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.
46+
The [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/) methodology has been adopted, with the exception of some experimental branches.
4747

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

50-
* `master`: Always reflects the state of the source code as of the latest release.‡
51-
* `develop`: Main development branch. The head of this branch contains the latest v4 development code.
52-
* `belvedere`: The latest attempt to develop CodeSnip 5. See the [Belvedere Readme file](https://github.com/delphidabbler/codesnip/blob/belvedere/README.md) for a full explanation.
53-
* `pagoda`: An abortive attempt at developing CodeSnip 5. Work on this branch has halted. It does not follow GitFlow methodology. ***Do not use this branch: it may be pruned.***
54-
* `pavilion`: Another attempt at working on CodeSnip 5. It branched off `pagoda` and work on it has halted. Again it does not follow GitFlow methodology. ***Do not use this branch: it may be pruned.***
55-
56-
New features and most bug fixes are worked on in `feature/xxxx` branches that are branched off `develop` locally. They are merged into `develop` as they are completed and the branches are deleted.
57-
58-
Note that the default branch on GitHub is `master`, which contains the state of the project as of the latest release. If you want to see the current state of play with new developments switch to `develop`.
50+
* [`master`](https://github.com/delphidabbler/codesnip/tree/master): Always reflects the state of the source code as of the latest release.‡
51+
* [`develop`](https://github.com/delphidabbler/codesnip/tree/develop): Main development branch. The head of this branch contains the latest v4 development code. Normal development of CodeSnip 4 takes place in `feature/xxx` branches off `develop`.
52+
* [`caboli`](https://github.com/delphidabbler/codesnip/tree/caboli): Experimental branch where an attempt is being made to (a) modernise the UI and (b) get the code to work properly when compiled with Delphi 11.
53+
* Abandoned branches:
54+
* [`pagoda`](https://github.com/delphidabbler/codesnip/tree/pagoda): An abortive attempt at developing CodeSnip 5.
55+
* [`pavilion`](https://github.com/delphidabbler/codesnip/tree/pavilion): Another attempt at working on CodeSnip 5 that branched off `pagoda`.
56+
* [`belvedere`](https://github.com/delphidabbler/codesnip/tree/belvedere): A thiird, failed attempt to develop CodeSnip 5 as a ground up rewrite. Not related to `pagoda` & `pavilion`.
5957

6058
> † Up to and including v4.13.1 the source code was kept in a Subversion repository on SourceForge. It was converted to Git in October 2015 and imported into GitHub. All releases from v3.0.0 are marked by tags in the form `version-x.x.x` where `x.x.x` is the version number. None of the Subversion branches made it through the conversion to Git, so to see a full history look at the old [SourceForge repository](https://sourceforge.net/p/codesnip/code/).
6159
@@ -65,7 +63,9 @@ Note that the default branch on GitHub is `master`, which contains the state of
6563

6664
To contribute to CodeSnip 4 development please fork the repository on GitHub. Create a feature branch off the `develop` branch. Make your changes to your feature branch then submit a pull request via GitHub.
6765

68-
> **Do not create branches off `master`, always branch from `develop`.**
66+
:warning: **Do not create branches off `master`, always branch from `develop`.**
67+
68+
:no_entry: Contributions to experimental branches are not being excepted just now.
6969

7070
#### Licensing of contributions
7171

0 commit comments

Comments
 (0)