summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2020-11-13 14:26:10 +0200
committerLars Wirzenius <liw@liw.fi>2020-11-13 14:26:10 +0200
commit33db34100b1c0c6ebf41cb65f14ffdf88f5af17d (patch)
tree2e06b8b2ef1e7208cd66b10d3d6698f13807ab74
parent73479123f4086474da9bb97f7c1dc4f3cf31cc6d (diff)
downloadobnam2-33db34100b1c0c6ebf41cb65f14ffdf88f5af17d.tar.gz
doc: add an abstract to the subplot
-rw-r--r--obnam.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/obnam.md b/obnam.md
index b3646d3..d6cbf59 100644
--- a/obnam.md
+++ b/obnam.md
@@ -391,4 +391,11 @@ functions:
- subplot/vendored/runcmd.py
classes:
- json
+abstract: |
+ Obnam is a backup system, consisting of a not very smart server for
+ storing chunks of backup data, and a client that splits the user's
+ data into chunks. They communicate via HTTP.
+
+ This document describes the architecture and acceptance criteria for
+ Obnam, as well as how the acceptance criteria are verified.
...