Skip to content

Commit 71f7c10

Browse files
author
delphidabbler
committed
Update project read-me
1 parent c639ac9 commit 71f7c10

File tree

1 file changed

+8
-19
lines changed

1 file changed

+8
-19
lines changed

README.md

Lines changed: 8 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,9 @@ A code bank designed with Pascal in mind.
1111

1212
## Overview
1313

14-
> **CodeSnip 4 Is No Longer Being Supported**.
15-
16-
> Bugs can no longer be reported and requests for new features in CodeSnip 4 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. Work started late Jan 2020.
19-
2014
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.
2115

22-
CodeSnip also provides offline access to the DelphiDabbler [Code Snippets Database](https://github.com/delphidabbler/code-snippets).
16+
CodeSnip can import code from the DelphiDabbler [Code Snippets Database](https://github.com/delphidabbler/code-snippets).
2317

2418
The program is available in both standard and portable editions.
2519

@@ -46,7 +40,7 @@ There's also plenty of info available on how to compile CodeSnip from source - s
4640

4741
## Source Code
4842

49-
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.
43+
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 in 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.
5044

5145
> 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.
5246
@@ -56,7 +50,7 @@ Up to and including release 4.13.1, `master` is simply a copy of the old Subvers
5650

5751
### Contributions
5852

59-
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.
53+
To contribute to the project please fork the repository on GitHub. Create a feature branch off the development branch. Make your changes to that branch then submit a pull request on GitHub.
6054

6155
### Compiling
6256

@@ -66,23 +60,18 @@ There is also an [FAQ](https://github.com/delphidabbler/codesnip-faq) -- (see [S
6660

6761
## Change Log
6862

69-
The program's current change log can be found in the file `Docs/ChangeLogs/ChangeLog-v4.txt` on the `master` branch.
63+
The program's current change log can be found in the file `Docs/ChangeLogs/ChangeLog-v4.txt` on the `master` branch. Change logs for other major releases are in the same directory.
7064

7165
## License
7266

73-
The program's EULA which gives full details of the license applying to the latest release can be found in the file `Docs\License.html` in the `master` branch. The license has changed between releases, so if you need to see an older one, select the appropriate `version-x.x.x` tag and read the older version of the file.
67+
The program's EULA, which gives full details of the license applying to the latest release, can be found in the file `Docs\License.html` in the `master` branch. The license has changed between releases, so if you need to see an older one, select the appropriate `version-x.x.x` tag and read the older version of the file.
7468

7569
Most of the original code is made available under the [Mozilla Public License v2](https://www.mozilla.org/MPL/2.0/).
7670

7771
The [CodeSnip Compiling & Source Code FAQ](https://github.com/delphidabbler/codesnip-faq/blob/master/SourceCode.md) may be useful if you have any queries about re-using CodeSnip source in other projects.
7872

79-
## CodeSnip 5 Development
80-
81-
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!)
82-
83-
Unfortunately `pagoda` has also been abandoned now. The branch has been left in place in case anyone else wants to continue development.
73+
## Bug Reports and Features
8474

85-
The idea behind v5 was to:
75+
You can report bugs or request new features using the [Issues section](https://github.com/delphidabbler/codesnip/issues) of the CodeSnip GitHub project. You will need a GitHub account to do this.
8676

87-
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.
88-
2. Increase the focus on the user's own code while downplaying the importance of code downloaded from the DelphiDabbler [Code Snippets database](https://github.com/delphidabbler/code-snippets), like [SWAG](https://github.com/delphidabbler/swag) is at present.
77+
Please do not report bugs unless you have checked whether the bug exists in the latest version of the program.

0 commit comments

Comments
 (0)