Skip to content

Commit 9281f52

Browse files
committedFeb 12, 2025·
Update README after releasing v0.1.7
1 parent b71a5be commit 9281f52

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed
 

‎README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@
33
This template uses the code-scaffolding tool [copier](https://copier.readthedocs.io/) to create a [LinkML](https://github.com/linkml/linkml) project.
44
Copier supports code lifecycle management, allowing you to seamlessly incorporate updates into your project when the template is enhanced.
55

6-
* Early releases (0.1.x) maintain backwards compatibility with [linkml-project-cookiecutter](https://github.com/linkml/linkml-project-cookiecutter/). This facilitates to experiment with the migration of existing cruft/cookiecutter-based projects.
7-
* Starting from 0.2.x we give up compatibility to introduce new features and to re-organise and clean-up the code. The migration from 0.1.x to 0.2.x is not too difficult but requires some manual work.
6+
* Starting from 0.2.x we give up compatibility to introduce new features and to re-organise and clean-up the code.
7+
* Early releases (0.1.x) have maintained backwards compatibility with [linkml-project-cookiecutter](https://github.com/linkml/linkml-project-cookiecutter/).
8+
This facilitates to experiment with the migration of existing cruft/cookiecutter-based projects.
9+
Over time the migration may become more difficult as the cookiecutter template evolves.
810

911
The generated project uses [just](https://github.com/casey/just) as preferred command runner, even in the 0.1.x releases.
1012

@@ -192,7 +194,7 @@ The commands are written to be run at the root of your project.
192194
The command for migrating to a specific tag/release is:
193195

194196
```shell
195-
copier copy --trust --vcs-ref v0.1.6 gh:dalito/linkml-project-copier .
197+
copier copy --trust --vcs-ref v0.1.7 gh:dalito/linkml-project-copier .
196198
```
197199

198200
Look into the `.cruft.json` file to find out which values you chose when you created your original project.

‎template/examples/README.md.jinja

+4
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,7 @@
33
This folder contains examples using the datamodel.
44

55
The source of the data used in the example is [tests/data](../tests/data/).
6+
7+
The command `just test` creates different representations of the data in [tests/data](../tests/data/) and writes them to the subfolder `output`.
8+
It also generates a markdown documentation of the examples which is not very useful in its current form.
9+
Hence, the `output` sub-folder is git-ignored.

0 commit comments

Comments
 (0)
Please sign in to comment.