Skip to content

Commit a03768e

Browse files
Update README.md
Modified re planned closure of delphidabbler.com and end of support / development.
1 parent 7183822 commit a03768e

File tree

1 file changed

+32
-33
lines changed

1 file changed

+32
-33
lines changed

README.md

Lines changed: 32 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -4,75 +4,76 @@ A code bank designed with Pascal in mind.
44

55
* [Overview](#overview)
66
* [Installation](#installation)
7-
* [Bugs & Feature Requests](#bugs--feature-requests)
87
* [Support](#support)
98
* [Source Code](#source-code)
109
* [Change Log](#change-log)
11-
* [CodeSnip 5 Development](#codesnip-5-development)
12-
* [Donate](#donate)
10+
* [CodeSnip 5 Development](#codesnip-5-development) -- **frozen**
1311

1412
## Overview
1513

14+
> **CodeSnip Is No Longer Being Supported**.
15+
16+
> Bugs can no longer be reported and requests for new features are no longer being accepted.
17+
18+
> It is hoped to produce one final version that removes the program's dependency on the delphidabbler.com webserver that is due to close 15th June 2020, but no guarantees.
19+
1620
CodeSnip is an open source code bank for storing and viewing your code snippets. While it can manage snippets in any source language, it is focussed mainly on Pascal and Delphi code for which additional features are available.
1721

18-
CodeSnip also provides offline access to the DelphiDabbler [Code Snippets Database](http://snippets.delphidabbler.com/).
22+
CodeSnip also provides offline access to the DelphiDabbler [Code Snippets Database](http://snippets.delphidabbler.com/) -- *deprecated*<sup> † ‡</sup>.
1923

2024
The program is available in both standard and portable editions.
2125

22-
For more information see [http://codesnip.delphidabbler.com/features](http://codesnip.delphidabbler.com/features).
26+
For more information see [http://codesnip.delphidabbler.com/features](http://codesnip.delphidabbler.com/features) -- *deprecated*<sup> †</sup>.
2327

2428
CodeSnip requires Windows 2000 or later and Internet Explorer 6 or later, although XP and IE 8 and later are preferred.
2529

26-
## Installation
27-
28-
CodeSnip is installed and removed using a standard Windows installer. Administrator privileges are required for installation.
29-
30-
## Bugs & Feature Requests
30+
<sup>†</sup> DelphiDabbler.com is due to close down on 15 June 2020. After this time these links will no longer work.
3131

32-
Bugs can be reported using the [Bug Tracker](https://sourceforge.net/p/codesnip/bugs/) on SourceForge. Info on how best to report bugs is provided on the tracker.
32+
<sup>‡</sup> It is hoped to move the Code Snippets Database to GitHub before DelphiDabbler.com closes down.
3333

34-
Feature requests can be made on the [Feature Request Tracker](https://sourceforge.net/p/codesnip/feature-requests/) on SourceForge. Once again info on how to proceed is provided.
34+
## Installation
3535

36-
> In time the bug and feature request trackers will be moved to GitHub.
36+
CodeSnip is installed and removed using a standard Windows installer. Administrator privileges are required for installation.
3737

3838
## Support
3939

40-
There's quite a lot of support available for CodeSnip:
40+
The following support is available for CodeSnip:
4141

4242
* A comprehensive help file.
43-
* A [read-me file](https://raw.githubusercontent.com/delphidabbler/codesnip/master/Docs/ReadMe.txt)<sup>*</sup> that discusses installation, configuration, updating and known issues.
44-
* A dedicated set of [web pages](http://delphidabbler.com/url/codesnip-home).
45-
* An [FAQ](http://wiki.delphidabbler.com/index.php/FAQs/CodeSnipAppUsing).
46-
* A [discussion group](https://sourceforge.net/p/codesnip/discussion) on SourceForge (albeit barely used!).
47-
* An [RSS news feed](http://delphidabbler.com/feeds/site-news-feed?id=codesnip). This can also be accessed via the program.
43+
* A [read-me file](https://raw.githubusercontent.com/delphidabbler/codesnip/master/Docs/ReadMe.txt)<sup> *</sup> that discusses installation, configuration, updating and known issues.
44+
* A dedicated set of [web pages](http://codesnip.delphidabbler.com/) -- *deprecated*<sup> †</sup>.
45+
* An [FAQ](http://wiki.delphidabbler.com/index.php/FAQs/CodeSnipAppUsing) -- *deprecated*<sup> † ‡</sup>.
46+
* An [RSS news feed](http://delphidabbler.com/feeds/site-news-feed?id=codesnip) -- *deprecated*<sup> †</sup>. This can also be accessed via the program.
4847
* A [Blog](http://codesnip-app.blogspot.co.uk/).
4948
* A [privacy statement](https://raw.githubusercontent.com/delphidabbler/codesnip/master/Docs/Privacy.txt)<sup>*</sup> that provides information about any personal information stored by the program and what info is transmitted over the net.
5049

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

5352
<sup>*</sup> These links take you to the most recent version of the documents -- they can change from release to release.
5453

54+
<sup>†</sup> These features are **deprecated** -- they are dependent on the delphidabbler.com web server which is due to close down on 15th June 2020.
55+
56+
<sup>‡</sup> This feature may be moved to GitHub -- no promises!
57+
5558
## Source Code
5659

5760
Up to and including release 4.13.1 the project's source code was maintained in a Subversion repository on [SourceForge](https://sourceforge.net/p/codesnip/code/). The Subversion repo was converted to Git on 21 5 October 2015 and imported to 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.
5861

5962
> Note that any branches that were created and deleted in the Subversion repo are missing from the Git history. So, for full details of the the project's history from v3.0.0 to v4.13.1 please refer to the old Subversion repo on SourceForge.
6063
61-
Following tag `version-4.13.1` the [Git Flow](http://nvie.com/posts/a-successful-git-branching-model/) methodology was adopted, with the exception that development work on CodeSnip v5 exists outside Git Flow in the `pagoda` branch (See below for details).
64+
Following tag `version-4.13.1` the [Git Flow](http://nvie.com/posts/a-successful-git-branching-model/) methodology was adopted. The exception is the `pagoda` branch that sits outside Git Flow. This branch was originally planned to be the CodeSnip v5 development branch (see [below](#codesnip-5-development) for details).
6265

6366
Up to and including release 4.13.1, `master` is simply a copy of the old Subversion `trunk` and, as such, contains various development commits along with numerous commits related to management of Subversion. After release 4.13.1, and the addition of this read-me file, `master` contains only commits relating to an actual release.
6467

6568
### Contributions
6669

67-
Contributions are welcome. Just fork the repo and create a feature branch off the `develop` branch. Commit your changes to your feature branch then submit a pull request when ready.
68-
69-
If you are contributing to CodeSnip 5 development please create your feature branch off the `pagoda` branch instead.
70+
Contributions are no longer accepted for this repo. If you wish to take over development, please fork the repo and take it where you wish.
7071

7172
### Compiling
7273

7374
`master` and each branch will have a file in the root directory named `Build.html` that gives detailed information about how to compile CodeSnip.
7475

75-
There is also a [FAQ](http://wiki.delphidabbler.com/index.php/FAQs/CodeSnipAppSource).
76+
There is also an [FAQ](http://wiki.delphidabbler.com/index.php/FAQs/CodeSnipAppSource) -- *deprecated* (see [Support](#support) above).
7677

7778
## Change Log
7879

@@ -88,16 +89,14 @@ The [CodeSnip Compiling & Source Code FAQ](http://wiki.delphidabbler.com/index.p
8889

8990
## CodeSnip 5 Development
9091

91-
Following a false start back in 2013/4 in the `parsnip` branch, development of CodeSnip 5 has restarted. The code can be found in the `pagoda` branch, which picks up where `parsnip` left off. (Don't ask where those names came from!)
92+
Following a false start back in 2013/4 in the `parsnip` branch, development of CodeSnip 5 restarted in the `pagoda` branch, which picked up where `parsnip` left off. (Don't ask where those names came from!)
9293

93-
At present the direction CodeSnip is being taken is to:
94+
Unfortunately `pagoda` has also been abandoned now. The branch has been left in place in case anyone else wants to continue development.
9495

95-
1. Generalise it to be a code bank for several different languages instead of just Pascal, while still providing some additional support for test-compiling Pascal code.
96-
2. Increase the focus on the user's own code while downplaying the importance of code downloaded from the DelphiDabbler [Code Snippets database](http://snippets.delphidabbler.com/). This will still be available but will be very much an add on, like [SWAG](http://swag.delphidabbler.com/) is at present.
97-
3. Remove the program's dependency on web services provided by [DelphiDabbler.com](http://delphidabbler.com) given the current uncertainty over that websites future.
98-
99-
Comments on these ideas are welcome - just create a [feature request](https://sourceforge.net/p/codesnip/feature-requests/) and select the `v5 (pagoda)` milestone.
96+
The idea behind v5 was to:
10097

101-
## Donate
98+
1. Generalise CodeSnip to be a code bank for several different languages instead of just Pascal, while still providing some additional support for test-compiling Pascal code.
99+
2. Increase the focus on the user's own code while downplaying the importance of code downloaded from the DelphiDabbler [Code Snippets database](http://snippets.delphidabbler.com/), like [SWAG](http://swag.delphidabbler.com/) is at present.<sup> †</sup>
100+
3. Remove the program's dependency on web services provided by [DelphiDabbler.com](http://delphidabbler.com) given the current uncertainty over that websites future.
102101

103-
If you've found the program useful please consider making a donation to help cover costs. Donations are accepted by [PayPal](http://delphidabbler.com/url/donate-cs) in British Pounds (GBP) -- [see common exchange rates](http://www.xe.com/currency/gbp-british-pound).
102+
<sup>†</sup> It is hoped to move the Code Snippets database to GitHub before DelphiDabbler closes down on 15 June 2020.

0 commit comments

Comments
 (0)