Skip to content
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

Update README.md #9

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

Update README.md #9

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
49 changes: 11 additions & 38 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,58 +1,31 @@
# imgraph: a package to create/manipulate graphs on images
# ImageGraph package

This package provides standard functions to
create and manipulate edge-weighted graphs
of images: create a graph, segment it,
compute its watershed, or its connected
components...
This package provides [*Torch*](http://torch.ch/) standard functions to create and manipulate edge-weighted graphs of images: create a graph, segment it, compute its watershed, or its connected components.

## Install
## Dependencies

1/ Torch7 is required:

Dependencies, on Linux (Ubuntu > 9.04):

``` sh
$ apt-get install gcc g++ git libreadline5-dev cmake wget libqt4-core libqt4-gui libqt4-dev libboost-all-dev
```

Dependencies, on Mac OS (Leopard, or more), using [Homebrew](http://mxcl.github.com/homebrew/):
The [*boost*](http://www.boost.org/) library is required. You can install it with one of the following commands

``` sh
$ brew install git readline cmake wget qt
apt-get install libboost-all-dev # on Ubuntu
brew install boost # on MacOS
```

Then on both platforms:
## Installation

``` sh
$ git clone https://github.com/andresy/torch
$ cd torch
$ mkdir build; cd build
$ cmake ..
$ make
$ [sudo] make install
```

2/ Once Torch7 is available, install this package:

``` sh
$ [sudo] torch-rocks install imgraph
luarocks install imgraph
```

## Use the library

First run torch, and load imgraph:

``` sh
$ torch
```
First run *Torch*, typing `th`, and load imgraph

``` lua
> require 'imgraph'
require 'imgraph'
```

Once loaded, tab-completion will help you navigate through the
library:
Once loaded, tab-completion will help you navigate through the library:

``` lua
> imgraph. + TAB
Expand Down