From b7eeeedc3f3ac169ac809f35669be45fd7fddbea Mon Sep 17 00:00:00 2001 From: Alexander Neumann Date: Wed, 3 Oct 2018 13:43:40 +0200 Subject: [PATCH] Add minimal docs for the top-level package Closes #173 --- doc.go | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 doc.go diff --git a/doc.go b/doc.go new file mode 100644 index 000000000..ff0a0796f --- /dev/null +++ b/doc.go @@ -0,0 +1,11 @@ +// Package restic gives a (very brief) introduction to the structure of source code. +// +// Overview +// +// The packages are structured so that cmd/ contains the main package for the +// restic binary, and internal/ contains almost all code in library form. We've +// chosen to use the internal/ path so that the packages cannot be imported by +// other programs. This was done on purpose, at the moment restic is a +// command-line program and not a library. This may be revisited at a later +// point in time. +package restic