Skip to content

Create README.md #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mittman wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Create README.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# squashdelta
Create efficient deltas (patches) between two SquashFS images

## Building from source
This project uses [autotools](http://inti.sourceforge.net/tutorial/libinti/autotoolsproject.html)
Copy link
Copy Markdown
Member

@mgorny mgorny Mar 23, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm against linking to some project's documentation that is in no way related to this project or upstream autotools.


```bash
$ git clone https://github.com/mgorny/squashdelta.git
$ cd squashdelta
Copy link
Copy Markdown
Member

@mgorny mgorny Mar 23, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's little activity in git, and there is a proper release .tar (in 'Releases') which is strongly recommended over it.

```

```bash
$ aclocal
$ autoconf
Copy link
Copy Markdown
Member

@mgorny mgorny Mar 23, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Those two are covered by autoreconf.

$ touch AUTHORS NEWS README ChangeLog
Copy link
Copy Markdown
Member

@mgorny mgorny Mar 23, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not needed at all.

$ mkdir build-aux
Copy link
Copy Markdown
Member

@mgorny mgorny Mar 23, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is probably unnecessary.

$ autoreconf --install
$ automake --add-missing
Copy link
Copy Markdown
Member

@mgorny mgorny Mar 23, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is already done by autoreconf.

```

```bash
$ ./configure --prefix=/opt/bin
Copy link
Copy Markdown
Member

@mgorny mgorny Mar 23, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a weird prefix to suggest. Please remember that users take this seriously, and they're going to end up installing in this weird location.

$ make
```

## Usage
```bash
$ ./squashdelta <source> <target> <patch-output>
```

## Whitepaper
https://dev.gentoo.org/~mgorny/articles/reducing-squashfs-delta-size-through-partial-decompression.pdf