Skip to content

Commit 5dcaf28

Browse files
author
DelphiDabbler
committed
Created README.md in project root for use on GitHub
1 parent bab0c83 commit 5dcaf28

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

README.md

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# CodeSnip
2+
3+
A code bank designed with Pascal in mind.
4+
5+
## Overview
6+
7+
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.
8+
9+
CodeSnip also provides offline access to the DelphiDabbler [Code Snippets Database](http://snippets.delphidabbler.com/).
10+
11+
The program is available in both standard and portable editions.
12+
13+
For more information see [http://codesnip.delphidabbler.com/features](http://codesnip.delphidabbler.com/features).
14+
15+
CodeSnip requires Windows 2000 or later and Internet Explorer 6 or later, although XP and IE 8 and later are preferred.
16+
17+
## Installation
18+
19+
CodeSnip is installed and removed using a standard Windows installer. Administrator privileges are required for installation.
20+
21+
## Source Code
22+
23+
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.
24+
25+
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` and `parsnip` branches (See below for details).
26+
27+
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. After release 4.13.1, and the addition of this read-me file, `master` contains only commits relating to an actual release.
28+
29+
### Contributions
30+
31+
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.
32+
33+
If you are contributing to CodeSnip 5 development please create your feature branch off the `pagoda` branch instead. **Don't use the `parsnip` branch.**
34+
35+
### Compiling
36+
37+
`master` and each branch will have a file in the root directory named `Build.html` that gives detailed information about how to compile CodeSnip.
38+
39+
There is also a [FAQ](http://wiki.delphidabbler.com/index.php/FAQs/CodeSnipAppSource).
40+
41+
## Change Log
42+
43+
The program's current change log can be found in the file `Docs/ChangeLogs/ChangeLog-v4.txt` on the `master` branch.
44+
45+
## License
46+
47+
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` and read the older version of the file.
48+
49+
Most of the original code is made available under the [Mozilla Public License v2](https://www.mozilla.org/MPL/2.0/).
50+
51+
The [CodeSnip Compiling & Source Code FAQ](http://wiki.delphidabbler.com/index.php/FAQs/CodeSnipAppSource) may be useful if you have any queries about re-using CodeSnip source in other projects.
52+
53+
## CodeSnip 5 Development
54+
55+
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!)
56+
57+
At present the direction CodeSnip is being taken is to:
58+
59+
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.
60+
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.
61+
3. Remove the program's dependency on web services provided by [DelphiDabbler.com](http://delphidabbler.com) given the current uncertainty over that websites future.
62+
63+
Comments on these ideas are welcome - just create an [issue](https://github.com/delphidabbler/codesnip/issues) and label it "CodeSnip 5 pagoda".

0 commit comments

Comments
 (0)