Skip to content

Commit 24a9ad3

Browse files
author
Peter Johnson
authored
Update README.md
Modified to describe DelphiDabbler Code Snippets database that is under development for use with forthcoming CodeSnip v4.16.
1 parent 30820fa commit 24a9ad3

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 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 be used to store a collection of reusable code snippets, mainly in Pascal.
4+
5+
> **NOTE:** Further collections may be added in the future.
46
57
## Purpose
68

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.
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.
810

911
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.
1012

1113
<sup>&dagger;</sup> Note though that some snippets depend on others. The meta data, in part, specifies those relationships.
1214

1315
## Collections
1416

15-
> Available collections will be described here.
16-
17-
## Development
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.)
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 is not compatible with versions of _CodeSnip_ up to v4.15.1.
2020
21-
## License
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 [`CollectionFormat.md`](csdb/docs/CollectionFormat.md) for further information.
2222

23-
By default the source code contained in each collection is released under the [MIT License](./LICENSE.md) ***unless either***:
23+
## Development
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+
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.
2626

27-
2. The snippet's source code specifies a license. In this case that license applies.
27+
## License
2828

29+
The license that applies to each section is specified by a text file named `LICENSE` stored with the collection's files.

0 commit comments

Comments
 (0)