Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Shostina authored Jul 24, 2023
1 parent 057790e commit a839e27
Showing 1 changed file with 7 additions and 51 deletions.
58 changes: 7 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,70 +5,26 @@

# <img src="http://rrwick.github.io/Bandage/images/logo.png" alt="Bandage" width="115" height="115" align="middle">Bandage-NG

## IMPORTANT: This is a fork of original Bandage repo. It may contain new features, new bugs and otherwise be not compatible with the Bandage by Ryan Wick. The documentation, instructions, etc. might be incomplete, missed and inaccurate as well
## IMPORTANT: This is a fork of <a href="https://github.com/asl/BandageNG">Bandage-NG repo</a>. It may contain new features, new bugs and otherwise be not compatible with the Bandage by Ryan Wick.

## Table of Contents
* [Intro](https://github.com/ctlab/BandageNG#intro)
* [Help](https://github.com/ctlab/BandageNG#help)
* [Pre-built binaries](https://github.com/ctlab/BandageNG#pre-built-binaries)
* [Building from source](https://github.com/ctlab/BandageNG#building-from-source)
* [Pre-built binaries](https://github.com/ctlab/BandageNG/wiki#pre-built-binaries)
* [Building from source](https://github.com/ctlab/BandageNG/wiki#prerequisites-for-building-from-the-source-code)
* [New features](https://github.com/ctlab/BandageNG/wiki#prerequisites-for-building-from-the-source-code)
* [Contributing](https://github.com/ctlab/BandageNG#contributing)
* [Citation](https://github.com/ctlab/BandageNG#citation)
* [Credits](https://github.com/ctlab/BandageNG#credits)
* [License](https://github.com/ctlab/BandageNG#license)


## Intro

Bandage-NG is a GUI program that allows users to interact with the assembly graphs made by *de novo* assemblers such as <a href="http://cab.spbu.ru/software/spades" target="_blank">SPAdes</a>, <a href="https://github.com/voutcn/megahit" target="_blank">MEGAHIT</a> and others.

*De novo* assembly graphs contain not only assembled contigs but also the connections between those contigs, which were previously not easily accessible. Bandage visualises assembly graphs, with connections, using graph layout algorithms. Nodes in the drawn graph, which represent contigs, can be automatically labelled with their ID, length or depth. Users can interact with the graph by moving, labelling and colouring nodes. Sequence information can also be extracted directly from the graph viewer. By displaying connections between contigs, Bandage opens up new possibilities for analysing and improving *de novo* assemblies that are not possible by looking at contigs alone.

## Help
New features:
1. [Rotate contig](https://github.com/ctlab/BandageNG/wiki#rotate-contig)
2. [Hi-C links](https://github.com/ctlab/BandageNG/wiki#rotate-contig)

Bandage-NG documentation is available on the <a href="https://github.com/ctlab/BandageNG/wiki" target="_blank">Bandage-NG GitHub wiki</a>.

Bandage-NG help tips are also built into the program. Throughout the UI, you will find these icons next to controls and settings: <img src="http://rrwick.github.io/Bandage/images/helptext.png" alt="help text icon" width="16" height="16">. Click them to see a description of that element of Bandage.

## Prerequisites (for building from the source code)
* Qt 6
* CMake
* C++17-compliant compiler

## Pre-built binaries

Pre-built Linux and Mac binaries are available from [Releases](https://github.com/ctlab/BandageNG/releases) page.

## Building from source

### CMake
```shell
mkdir build
cd build
cmake ..
make
```

## Contributing

New contributors are welcome! If you're interested or have ideas, please use Issues section in the repo.


## Citation

TBD


## Credits

Bandage-NG makes use of the <a href="http://www.ogdf.net/" target="_blank">OGDF</a> library for performing graph layout algorithms. Big thanks goes out to the OGDF developers for their excellent work!

* <a href="https://github.com/rrwick" target="_blank">Ryan Wick</a> (author of original Bandage)
* <a href="https://github.com/rchikhi" target="_blank">Rayan Chikhi</a>
* <a href="https://github.com/epruesse" target="_blank">Elmar Pruesse</a>
* <a href="https://github.com/wafemand" target="_blank">Andrey Zakharov</a>
* <a href="https://github.com/asl" target="_blank">Anton Korobeynikov</a>

## License

GNU General Public License, version 3

0 comments on commit a839e27

Please sign in to comment.