mirror/restic
1
0
Fork 0
mirror of https://github.com/restic/restic.git synced 2024-12-22 07:43:03 +00:00
Code Issues Releases Wiki Activity

Add minimal docs for the top-level package

Browse source 
Closes #173
This commit is contained in:
Alexander Neumann 2018-10-03 13:43:40 +02:00
parent a20d4bc6b0
commit b7eeeedc3f
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
doc.go Normal file
View file

@ -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