Skip to content

Commit

Permalink
Add minimal docs for the top-level package
Browse files Browse the repository at this point in the history
Closes restic#173
  • Loading branch information
fd0 committed Oct 3, 2018
1 parent a20d4bc commit b7eeeed
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions doc.go
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit b7eeeed

Please sign in to comment.