Skip to content

Commit

Permalink
Update README (#11)
Browse files Browse the repository at this point in the history
- Rewrite/update dependencies
- Modified section structure
- Add docker commands
  • Loading branch information
Michael Geitz committed Apr 15, 2018
1 parent ccb601a commit ee8e879
Showing 1 changed file with 24 additions and 8 deletions.
32 changes: 24 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,31 @@ Formatting a filesystem wipes each available least significant bit in the images
The [wiki](https://github.com/mgeitz/albumfs/wiki) contains an implementation summary and some additional details.

### Dependencies
* libfuse-dev
* libpng-dev
* libssl-dev
* pkg-config

#### Debian
```sh
$ apt-get install build-essential pkg-config libfuse-dev libpng-dev libssl-dev
```

#### CentOS
```sh
$ yum group install "Development Tools"
$ yum install fuse fuse-devel libpng libpng-devel openssl openssl-devel
```

### Getting Started

### Compile
* make all
* sudo make install
#### Compile
```sh
$ make all
$ sudo make install
```

#### Docker
```sh
$ docker-compose build albumfs
$ docker-compose run --rm albumfs
```


### Commands
Expand All @@ -32,8 +48,8 @@ The [wiki](https://github.com/mgeitz/albumfs/wiki) contains an implementation su
| -debug | enable bit by bit debug output. IO blocking from this output will cause the filesystem to operate very slowly.|
| -help | echo command syntax and exit program.|

#### Examples

### Examples
```sh
$ albumfs -format images/vacation/image.png
```
Expand Down

0 comments on commit ee8e879

Please sign in to comment.