vbatts/tar-split
1
0
Fork 0
forked from mirrors/tar-split
Code Releases Activity

README: cleanup

Browse source
This commit is contained in:
Vincent Batts 2015-08-10 15:29:08 -04:00
parent 779e824d76
commit 5d0b967302
1 changed files with 18 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -10,10 +10,20 @@ and the raw file payload, one could reassemble the original archive.
## Docs ## Docs
Code API for libraries provided by `tar-split`:
* https://godoc.org/github.com/vbatts/tar-split/tar/asm * https://godoc.org/github.com/vbatts/tar-split/tar/asm
* https://godoc.org/github.com/vbatts/tar-split/tar/storage * https://godoc.org/github.com/vbatts/tar-split/tar/storage
* https://godoc.org/github.com/vbatts/tar-split/archive/tar * https://godoc.org/github.com/vbatts/tar-split/archive/tar
## Install
The command line utilitiy is installable via:
```bash
go get github.com/vbatts/tar-split/cmd/tar-split
```
## Caveat ## Caveat
Eventually this should detect TARs that this is not possible with. Eventually this should detect TARs that this is not possible with.
@ -40,7 +50,7 @@ Do not break the API of stdlib `archive/tar` in our fork (ideally find an upstre
The version of golang stdlib `archive/tar` is from go1.4.1, and their master branch around [a9dddb53f](https://github.com/golang/go/tree/a9dddb53f) The version of golang stdlib `archive/tar` is from go1.4.1, and their master branch around [a9dddb53f](https://github.com/golang/go/tree/a9dddb53f)
## Concept ## Design
See the [design](concept/DESIGN.md). See the [design](concept/DESIGN.md).
@ -52,7 +62,12 @@ file (sometimes more), at least 1024 null bytes on the end, and then various
padding. This makes for a constant linear growth in the stored metadata, with a padding. This makes for a constant linear growth in the stored metadata, with a
naive storage implementation. naive storage implementation.
Reusing our prior example's `tar-split.tar`, let's build the checksize.go example: First we'll get an archive to work with. For repeatability, we'll make an
archive from what you've just cloned:
```
git archive --format=tar -o tar-split.tar HEAD .
```
``` ```
go build ./checksize.go go build ./checksize.go