Ship the runtime and docs with the cabal distribution

tchoutri · May 27, 2024 · 6b393d0 · 6b393d0
1 parent 0995045
commit 6b393d0
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/confer.cabal b/confer.cabal
@@ -3,7 +3,10 @@ name:            confer
 version:         0.1.0.0
 synopsis:        The dotfiles manager
 
--- description:
+description:
+  Confer is a configuration file manager that symlinks your configuration files into their appropriate locations.
+  You can put your configuration files in version control and make them easily available to their applications.
+
 license:         BSD-3-Clause
 license-file:    LICENSE
 author:          Théophile Choutri
@@ -13,6 +16,10 @@ build-type:      Simple
 extra-doc-files:
   CHANGELOG.md
   README.md
+  doc/*.md
+
+data-dir:
+  runtime/lua
 
 tested-with:     GHC ==9.10.1
 

diff --git a/doc/ARCHITECTURE.md b/doc/ARCHITECTURE.md
@@ -28,6 +28,6 @@ All standard libraries of the Lua 5.4 interpreter are made available.
 *Confer* provides its own APIs to query the host machine's information and the current 
 users's information, like the home directory.
 
-The `confer` namespace is implemented in pure Lua.
+The `confer` namespace is implemented in pure Lua. It is distributed with `confer`.
 The `host` and `user` namespaces are implemented in Haskell and made available 
 to the Lua environment.