forked from restic/restic
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add minimal docs for the top-level package
Closes restic#173
- Loading branch information
Showing
1 changed file
with
11 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |