From 04b8bd74450fe65ae69e7af89a4a08019b5ffb6a Mon Sep 17 00:00:00 2001 From: Joscha Date: Sat, 14 Mar 2020 01:47:41 +0000 Subject: [PATCH] [all] Include summary of subprojects in readme --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bcabaf8..6dbb792 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,19 @@ # forest -Forest is an experiment in tree-based interaction. +Forest is an experiment in tree-based interaction: One or more clients connect +to a server and interact with it (and each other) via an interface consisting of +text-based nodes forming a tree. + +The project is split into multiple subprojects, most of which are Haskell +packages. For more information on individual subprojects, see their README or +the summary below. [API documentation](docs/API.md) + +## Subprojects + +- [forest-cabin](forest-cabin/): Server (Haskell) +- [forest-common](forest-common/): Common types and functions (Haskell) +- [forest-server](forest-server/): Server framework (Haskell) +- [forest-tui](forest-tui/): Terminal-based client (Haskell) +- [forest-web](forest-web/): Web-based client (static site)