Add naming/namespace conventions for lib/*
commit1db805520cf349e931c82663dc4c9d4069aff40e
authorSridhar Ratnakumar <srid@srid.ca>
dateTue 29 May 2018, 15:09 (8 years ago)
parentbe26c0f
lib/README.md+3−1
@@ -1 +1,3 @@
1−Libraries provided by obelisk
1+# Obelisk libraries
2+
3+This directory contains libraries provided by obelisk. By convention they are prefixed with `obelisk-` and their module exports all lie within the `Obelisk` import namespace. For example, to include `cliapp` as a dependency you would add `obelisk-cliapp` to your cabal dependencies, and import `Obelisk.CliApp...` in the source files.