https://github.com/crownedgrouse/edgar

Erlang Does Gnu AR
https://github.com/crownedgrouse/edgar

erlang gnu-ar

Last synced: 3 months ago
JSON representation

Erlang Does Gnu AR

• Host: GitHub
• URL: https://github.com/crownedgrouse/edgar
• Owner: crownedgrouse
• License: isc
• Created: 2014-09-06T21:43:57.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2017-08-31T21:11:06.000Z (over 7 years ago)
• Last Synced: 2024-10-08T14:41:45.088Z (4 months ago)
• Topics: erlang, gnu-ar
• Language: Erlang
• Size: 86.9 KB
• Stars: 3
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# edgar #

Erlang Does Gnu AR.

## Overview ##

``edgar`` is a module inspired of ``erl_tar`` and doing ``GNU ar`` archive format.

Same API than ``erl_tar`` is exported, except ``add/3`` and ``add/4`` (to be done in a next version).

## Documentation ##

A complete documentation is available.

Simply run `make docs` and open `doc/index.html` in your favorite browser, this will insure you having the documentation related to your version.

## Quick Start ##

```

git clone git://github.com/crownedgrouse/edgar.git

cd edgar

make

erl -pa `pwd`/ebin

```

## Running tests caveat ##

When cloning project, references `ar` files have to be created first, as reference files coming with new timestamps and UID/GID.

To do so simply run `make init_test` once.

You can then run `make tests`.

Note : Test initialization need `ar` tool to be installed. Running tests on some platform/OS may not be possible, then.

But this does not mean `edgar` cannot be used on those platform/OS.

## Contributing ##

Contributions are welcome. Please use pull-requests.