Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
angelsolaorbaiceta authored Sep 3, 2024
1 parent a881c5e commit c253fdf
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,51 @@

An archiving tool that xz-compresses and bundles files together into an archive.

## Installation

Make sure you’ve correctly installed Go v1.23 or greater and that the Go binaries are in your PATH (you want to append `$GOPATH/bin` to your `PATH` to access installed Go binaries).
Then:

```bash
$ go install https://github.com/angelsolaorbaiceta/angel-archives@latest
```

You should have the _aar_ utility in your path:

```bash
$ which aar
/Users/yourusername/go/bin/aar
```

Where in the example above, `/Users/yourusername/go` is the value of the `$GOPATH` variable.

### Installation from source

Alternatively, you can clone the repository:

```bash
$ git clone https://github.com/angelsolaorbaiceta/angel-archives
```

Install the project dependencies:

```bash
$ go mod tidy
```

And install the binary in your `$GOPATH/bin` by simply doing:

```bash
$ make install
```

You should have the _aar_ utility in your path:

```bash
$ which aar
/Users/yourusername/go/bin/aar
```

## Usage

Creating an archive:
Expand Down Expand Up @@ -51,4 +96,10 @@ Example:
"test.txt" // File name
0x00 0x00 0x00 0x1B // Offset (27 bytes)
0x0B 0x00 0x00 0x00 // Length (11 bytes)
... // Next go the file bytes
```

### Archive Files

The files are stored sequentially after the header.
Their raw bytes are xz-compressed before being saved to disk.

0 comments on commit c253fdf

Please sign in to comment.