diff --git a/README.md b/README.md index 5426521..ab599eb 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,21 @@ _A template for LinkML projects_ NOTE: You don't need to directly use this repository directly! -Instead: +## Prerequisites - * [install poetry](https://python-poetry.org/docs/) - * [install linkml](https://linkml.io/linkml/intro/install.html) - * run `linkml-ws new` +This repository is designed to be used via the `linkml-ws` script in the +[`linkml` package](https://github.com/linkml/linkml). We encourage running +that script via `pipx`. If you haven't already, follow +[these instructions](https://pypa.github.io/pipx/#install-pipx) to install `pipx`. -## Example: +The project that `linkml-ws` generates uses [Poetry](https://python-poetry.org/) +for dependency management. So be sure to have that +[installed](https://python-poetry.org/docs/#installation), too. +## Example ``` -mkdir ~/my-projects -cd ~/my-projects -pip install linkml -linkml-ws new my-project-name +pipx run --spec linkml linkml-ws new my-project-name cd my-project-name # edit src/linkml/my-project-name make setup