Repository files navigation

A code bank designed with Pascal in mind.

• Overview
• Installation
• Support
• Source Code
• Compiling
• Contributing
• Change Log
• License
• Bug Reports and Feature Requests

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 focused mainly on Pascal and Delphi code for which additional features are available.

The program is available in both standard and portable editions.

CodeSnip can import code from the DelphiDabblerCode Snippets Database and theSWAG Pascal Code Collection.

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

The portable edition has no installer. Simply follow the instructions in theread me file that is included in the download.

The programshould run on Windows 2000, with Internet Explorer 6 or later, although XP and IE 8 and later are recommended.But note that recent releases of CodeSnip have only been tested on Windows 10 & 11.

The following support is available to CodeSnip users:

• A comprehensive help file.
• A read-me file that discusses installation, configuration, updating and known issues. There are different versions of this file for each edition of CodeSnip: one for thestandard edition and another for theportable edition.¹
• TheUsing CodeSnip FAQ.
• TheDelphiDabbler Blog that provides CodeSnip news.
• CodeSnip's ownWeb Page.

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

CodeSnip's source code is maintained in thedelphidabbler/codesnip Git repository on GitHub.²

TheGit Flow methodology has been adopted for CodeSnip 4 development. The following branches are used:

• master: Always reflects the state of the source code as of the latest release.³
• develop: The head of this branch contains the latest v4 development code. Normal development of CodeSnip 4 takes place in feature branches that are then merged intodevelop.
• Feature branches, with names of the formfeature/<feature-name>. Normally such branches are only used locally, but occasionally some feature branches may be pushed to the main repository.

You will find other branches in the repository. These are either experimental or abandoned. To find out more about them switch to the required branch and read itsREADME.md file.

If you want to compile CodeSnip 4 from source code you will need the rather long-in-the-tooth Delphi XE. Seethis FAQ to find out why.

Full instructions on setting up the build environment are provided inBuild.html.

Please seeCONTRIBUTING.md for details of how to contribute to the CodeSnip project.

⛔ Contributions to experimental and abandoned branches are not accepted.

The change log can be found in the fileCHANGELOG.md.⁴

A summary of CodeSnip's license can be found inLICENSE.md and the complete license text is inDocs\License.html.⁵

TheCodeSnip Compiling & Source Code FAQ may be useful if you have any queries about re-using the CodeSnip source code in other projects.

Report bugs and requests for new features are welcome. Please see theIssues section ofCONTRIBUTING.md for information about how to proceed.