Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 37 lines (29 sloc) 0.752 kb
e2df982 @GrahamRanson Initial commit
GrahamRanson authored
1 GGTar
2e68d2e @GrahamRanson Adding usage example
GrahamRanson authored
2 ============
e2df982 @GrahamRanson Initial commit
GrahamRanson authored
3
2e68d2e @GrahamRanson Adding usage example
GrahamRanson authored
4 This is a GGified version of the Tar module for the LuaRocks project provided
5 here - https://github.com/keplerproject/luarocks/blob/master/src/luarocks/tools/tar.lua
6
7 Basic Usage
8 -------------------------
9
10 ##### Require The Code
11 ```lua
12 local GGTar = require( "GGTar" )
13 ```
14
15 ##### Create your GGTar object
16 ```lua
17 local tar = GGTar:new()
18 ```
19
20 ##### Untar an archive in the temp directory into the documents directory and call a function when done.
21 ```lua
22 local onComplete = function()
23 print( "All done!" )
24 end
25 tar:untar( "level1.tar", system.DocumentsDirectory, system.TemporaryDirectory, onComplete )
26 ```
27
28 ##### Destroy this GGTar object
29 ```lua
30 tar:destroy()
31 ```
32
33 Update History
34 -------------------------
35
36 ##### 0.1
37 Initial release
Something went wrong with that request. Please try again.