diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..41848cd14cc9ce4c525ba9217b3f741ada6b91f7 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# tar-split + +Archive a large directory in manageable chunks. + +## Generate + +```bash +./generate large-directory/ +``` + +A set of tar files called `file-[\d].tar` will be created in this directory. + +## Extract + +**All segments of the chunked archive must be present to untar.** + +If the tar files are gzipped or otherwise compressed, uncompress them back to tarballs first. They cannot, however, be individually untarred. + +```bash +./extract +``` + +The archives will be extracted relative to this directory. + +## Credit & License + +Credit belongs to enzotib and Nemo on [StackExchange](https://unix.stackexchange.com/a/21374). +Licensed under CC 3.0 By-SA.