From 7e669bcf6b6336ec429da949bcb4aa456971dba2 Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Fri, 30 Jul 2021 10:38:27 +0200 Subject: folding history in preparation of GNU Anastasis v0.0.0 release --- README | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 README (limited to 'README') diff --git a/README b/README new file mode 100644 index 0000000..7a09d7b --- /dev/null +++ b/README @@ -0,0 +1,42 @@ +============= +GNU ANASTASIS +============= + +This package includes the Anastasis core logic. The code is released +under the GNU Affero General Public License (v3 or later). See +COPYING for details. + +Description +=========== + +GNU Anastasis is a key backup and recovery tool from the GNU project. +This package includes the backend run by the Anastasis providers as +well as libraries for clients and a command-line interface. + +Dependencies +============ + +libjansson : MIT License +libgcrypt : LGPL +postgresql : PostgreSQL License +libgnunet* : GPLv3+, +libtaler* : GPLv3+ +GNU recutils: GPLv3+ (when building from Git) + + +Directory structure +=================== + +src/include/ includes installed (public) headers +src/util/ implements helper and crypto routines +src/backend/ contains the REST service +src/stasis/ implements the database logic for the backend +src/authorization/ contains various authorization plugins +src/restclient/ implements a REST client for the backend +src/lib/ implements the main client-side backup and recovery logic +src/testing/ contains test cases for 'src/restclient/' and 'src/lib/' +src/reducer/ implements a reducer API on top of 'src/lib/' +src/cli/ includes a reducer-based command-line interface +contrib/ contains resource files, like what identity attributes to ask for +doc/ contains documentation files, like TeXinfo +po/ internationalization via GNU gettext -- cgit v1.2.3