|
1 | 1 | # Code Snippets Collections |
2 | 2 |
|
3 | | -This repository is be used to store a collection of reusable code snippets, mainly in Pascal. |
| 3 | +This repository is used to store a collection of reusable code snippets, mainly in Pascal. |
4 | 4 |
|
5 | 5 | > **NOTE:** Further collections may be added in the future. |
6 | 6 |
|
7 | 7 | ## Purpose |
8 | 8 |
|
9 | | -The collections that are (and will be) included here are designed, by and large, for use with the _DelphiDabbler [CodeSnip](https://github.com/delphidabbler/codesnip)_ program. |
| 9 | +The purpose of this repository is to provide collections of snippets for use with the _DelphiDabbler [CodeSnip](https://github.com/delphidabbler/codesnip)_ program. |
10 | 10 |
|
11 | | -Having said that, the source code in the collections can be used stand-alone<sup>†</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. |
12 | | - |
13 | | -<sup>†</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. |
14 | 12 |
|
15 | 13 | ## Collections |
16 | 14 |
|
17 | | -So far there is just one collection, the DelphiDabbler Code Snippets Database. This collection is the (as yet unreleased) final version of the database. It is designed for use with the forthcoming releases of _CodeSnip_ (v4.16 and later) that do not get the database from DelphiDabbler.com. (DelphiDabbler.com is due to close in June 2020.) |
| 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. |
18 | 16 |
|
19 | 17 | > The collection is not compatible with versions of _CodeSnip_ up to v4.15.1. |
20 | 18 |
|
21 | | -The collection can be found in the `csdb/v4.16` 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. |
| 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. |
22 | 20 |
|
23 | 21 | ## Development |
24 | 22 |
|
25 | 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. |
26 | 24 |
|
27 | | -## License |
| 25 | +## Licenses |
| 26 | + |
| 27 | +The license that applies to this project can be found in `LICENSE.md` in the repo's root directory. |
28 | 28 |
|
29 | | -The license that applies to each section is specified by a text file named `LICENSE` stored with the collection's files. |
| 29 | +Code snippets in collections may have a different license or licenses. See the documentation of each collection for details. |
0 commit comments