aboutsummaryrefslogtreecommitdiff
path: root/example_packages/README.md
diff options
context:
space:
mode:
authorBrad Richardson <everythingfunctional@protonmail.com>2020-10-14 09:24:55 -0500
committerBrad Richardson <everythingfunctional@protonmail.com>2020-10-14 09:24:55 -0500
commitb5b16cf826d468e79b4087500192a4a9e07c140f (patch)
tree1f615ee9ed6500bb1f6964ef2af0478b2fe51e4e /example_packages/README.md
parentd3a65e36b28808c2c51ae41fc107f1179e27a08c (diff)
downloadfpm-b5b16cf826d468e79b4087500192a4a9e07c140f.tar.gz
fpm-b5b16cf826d468e79b4087500192a4a9e07c140f.zip
Better organize example packages and bootstrap tests
Diffstat (limited to 'example_packages/README.md')
-rw-r--r--example_packages/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/example_packages/README.md b/example_packages/README.md
new file mode 100644
index 0000000..79fadb1
--- /dev/null
+++ b/example_packages/README.md
@@ -0,0 +1,20 @@
+# 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 |
+|---------------------|---------------------------------------------------------------|:-----------------------:|:---:|
+| auto_discovery_off | Default layout with auto-discovery disabled | N | Y |
+| 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_complex_2 | Auto-discovery of tests and executables with modules | N | 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 |
+| program_with_module | App-only; module+program in single source file | Y | Y |
+| 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