Skip to content

Commit 01f50a2

Browse files
author
delphidabbler
committedMay 2, 2020
Merge branch 'release/2.0.0'
2 parents ac5ed3c + 3b03817 commit 01f50a2

File tree

670 files changed

+25561
-12
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

670 files changed

+25561
-12
lines changed
 

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
_release

‎README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,29 @@
11
# Code Snippets Collections
22

3-
This repository will be used to store one or more collections of reusable code snippets, mainly in Pascal.
3+
This repository is used to store a collection of reusable code snippets, mainly in Pascal.
44

5-
## Purpose
5+
> **NOTE:** Further collections may be added in the future.
66
7-
The collections that **will be** included here are designed, by and large, for use with the _DelphiDabbler [CodeSnip](https://github.com/delphidabbler/codesnip)_ program.
7+
## Purpose
88

9-
Having said that, the source code in the collections can be used stand-alone<sup>&dagger;</sup>. Each collection has meta data associated with it that was originally designed for use with _CodeSnip_, but can be used with any other software designed to parse the meta data. The meta data file formats will be documented.
9+
The purpose of this repository is to provide collections of snippets for use with the _DelphiDabbler [CodeSnip](https://github.com/delphidabbler/codesnip)_ program.
1010

11-
<sup>&dagger;</sup> Note though that some snippets depend on others. The meta data, in part, specifies those relationships.
11+
However the intent is that other applications will also be able to use the collections by parsing the meta data provided with the collections. It is intended that the meta data will be fully documented.
1212

1313
## Collections
1414

15-
> Available collections will be described here.
15+
So far there is just one collection, the _DelphiDabbler Code Snippets Database_. This collection is version 2 of the database. It is designed for use with _CodeSnip_ v4.16 and later.
1616

17-
## Development
17+
> The collection is not compatible with versions of _CodeSnip_ up to v4.15.1.
1818
19-
The repo uses the [Git Flow](http://nvie.com/posts/a-successful-git-branching-model/) methodology - i.e. development proceeds on the `develop` branch and `feature` branches off it. Only released content appears on the `master` branch.
19+
The collection can be found in the `csdb` directory. The actual collection is contained in the `collection` sub-directory and it is documented in the `docs` sub-directory - see `collection-format.html` for further information.
2020

21-
## License
21+
## Development
2222

23-
By default the source code contained in each collection is released under the [MIT License](./LICENSE.md) ***unless either***:
23+
This repo uses the [Git Flow](http://nvie.com/posts/a-successful-git-branching-model/) methodology - i.e. development proceeds on the `develop` branch and `feature` branches off it. Only released content appears on the `master` branch.
2424

25-
1. The directory containing the collection has its own `LICENSE.md` file - the license specified by such a file then takes precedence; ***or***
25+
## Licenses
2626

27-
2. The snippet's source code specifies a license. In this case that license applies.
27+
The license that applies to this project can be found in `LICENSE.md` in the repo's root directory.
2828

29+
Code snippets in collections may have a different license or licenses. See the documentation of each collection for details.

0 commit comments

Comments
 (0)
Please sign in to comment.