summaryrefslogtreecommitdiff
path: root/libraries/ghc-compact/README.md
diff options
context:
space:
mode:
authorEdward Z. Yang <ezyang@cs.stanford.edu>2017-02-23 13:46:02 -0800
committerEdward Z. Yang <ezyang@cs.stanford.edu>2017-02-26 01:23:35 -0800
commita0b4a2ac5015e9accd4fb71290a68ce1a1d3d630 (patch)
treea7c762f501bc072c81d27c71e0640f9490a36819 /libraries/ghc-compact/README.md
parent8f20844d3435094583db92a30550ca319d2be863 (diff)
downloadhaskell-a0b4a2ac5015e9accd4fb71290a68ce1a1d3d630.tar.gz
Rename compact to ghc-compact.
Summary: The plan is to release a separate library, 'compact', which gives a friendly user-facing interface. This library is just enough so that we can make sure the functionality is working in GHC. Signed-off-by: Edward Z. Yang <ezyang@cs.stanford.edu> Test Plan: validate Reviewers: bgamari, dfeuer, austin, simonmar, hvr Subscribers: thomie, erikd, snowleopard Differential Revision: https://phabricator.haskell.org/D3206
Diffstat (limited to 'libraries/ghc-compact/README.md')
-rw-r--r--libraries/ghc-compact/README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/libraries/ghc-compact/README.md b/libraries/ghc-compact/README.md
new file mode 100644
index 0000000000..0b7d197c88
--- /dev/null
+++ b/libraries/ghc-compact/README.md
@@ -0,0 +1,5 @@
+The `compact` Package
+=====================
+
+Exposes a single data structure, called a Compact, which contains
+fully evaluated data closed under pointer reachability.