Garmelon/forest
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[all] Include summary of subprojects in readme

Browse source
This commit is contained in:
Joscha 2020-03-14 01:47:41 +00:00
parent 56373a0748
commit 04b8bd7445
1 changed files with 15 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -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)