aboutsummaryrefslogtreecommitdiff
path: root/test/example_packages
diff options
context:
space:
mode:
authorLKedward <laurence.kedward@bristol.ac.uk>2020-09-18 11:39:33 +0100
committerLKedward <laurence.kedward@bristol.ac.uk>2020-09-18 11:39:33 +0100
commit02ffa065b8a84828645ef13fd3447d346f23e257 (patch)
treed988886362c0b30f5b1f4df3b974b78ca4a3aed0 /test/example_packages
parent35f4779647ddab4ef7edef26b4e0027004d6c756 (diff)
downloadfpm-02ffa065b8a84828645ef13fd3447d346f23e257.tar.gz
fpm-02ffa065b8a84828645ef13fd3447d346f23e257.zip
Add: README for example packages
Diffstat (limited to 'test/example_packages')
-rw-r--r--test/example_packages/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/test/example_packages/README.md b/test/example_packages/README.md
new file mode 100644
index 0000000..086b967
--- /dev/null
+++ b/test/example_packages/README.md
@@ -0,0 +1,17 @@
+# Example packages
+
+See the table below for a list of the example packages provided in this directory including
+the features demonstrated in each package and which versions of fpm are supported.
+
+
+| Name | Features | Bootstrap (Haskell) fpm | fpm |
+|------------------|---------------------------------------------------------------|:-----------------------:|:---:|
+| circular_example | Local path dependency; circular dependency | Y | N |
+| circular_test | Local path dependency; circular dependency | Y | N |
+| hello_complex | Non-standard directory layout; multiple tests and executables | Y | Y |
+| hello_fpm | App-only; local path dependency | Y | N |
+| hello_world | App-only | Y | Y |
+| makefile_complex | External build command (makefile); local path dependency | Y | N |
+| submodules | Lib-only; submodules (3 levels) | N | Y |
+| with_c | Compile with `c` source files | N | Y |
+| with_makefile | External build command (makefile) | Y | N | \ No newline at end of file