aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastian Ehlert <28669218+awvwgk@users.noreply.github.com>2020-12-08 20:09:54 +0100
committerSebastian Ehlert <28669218+awvwgk@users.noreply.github.com>2020-12-10 18:00:02 +0100
commit50723700d253c83e4b68930370c3b0819e529be3 (patch)
treef46ee62ec3589ff3f2aa2b624ae60be6d5c7e92c
parent63a565fab4300e43fbd2d06b23d3c1f2a4e1976e (diff)
downloadfpm-50723700d253c83e4b68930370c3b0819e529be3.tar.gz
fpm-50723700d253c83e4b68930370c3b0819e529be3.zip
Create specification for example section
-rw-r--r--manifest-reference.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/manifest-reference.md b/manifest-reference.md
index f1394cb..43e20d3 100644
--- a/manifest-reference.md
+++ b/manifest-reference.md
@@ -260,6 +260,41 @@ executable = [
```
+### Example targets
+
+Example applications for a project are defined as *example* sections.
+If no example section is specified the ``example`` directory is searched for program definitions.
+For explicitly specified examples the *name* entry must always be specified.
+The source directory for each example can be adjusted in the *source-dir* entry.
+Paths for the source directory are given relative to the project root and use ``/`` as path separator on all platforms.
+The source file containing the program body can be specified in the *main* entry.
+
+Examples can have their own dependencies.
+See [specifying dependencies](#specifying-dependencies) for more details.
+
+> Dependencies supported in Bootstrap fpm only
+
+Examples can also specify their own external library dependencies.
+See [external libraries](#link-external-libraries) for more details.
+
+> Linking against libraries is supported in Fortran fpm only
+
+*Example:*
+
+```toml
+[[ example ]]
+name = "demo-app"
+source-dir = "demo"
+main = "program.f90"
+
+[[ example ]]
+name = "example-tool"
+link = "z"
+[example.dependencies]
+helloff = { git = "https://gitlab.com/everythingfunctional/helloff.git" }
+```
+
+
### Test targets
Test targets are Fortran programs defined as *test* sections.