Skip to content

Commit f37fa18

Browse files
committed
Add Group members to readme (#28)
Closes #48 * Add introduction and team to readme The Programming Life organization kindly requested doing this. * Add Travis build status for dev branch * Update README.md Piece of text for #48 * Add Documentation to README
1 parent 061bc0c commit f37fa18

1 file changed

Lines changed: 35 additions & 1 deletion

File tree

README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,35 @@
1-
# PL2-2016
1+
# DNAv [![Build Status](https://travis-ci.org/ProgrammingLife2016/PL2-2016.svg?branch=dev)](https://travis-ci.org/ProgrammingLife2016/PL2-2016)
2+
3+
DNAv (pronounced D-Nav) is a shorthand for DNA Navigation. This application is a semantic visualization tool for analysis of DNA sequences, aimed at biogenetic researchers. The application uses sophisticated data management to process a collection of sequences and detects areas of interest for the user, which it shows in a graphical user interface.
4+
5+
### Scientific Importance
6+
DNAv attempts to aide researchers in discovering the mysteries of evolution of the Tuberculosis bacterium. This bacterium evolves at a rapid pace, and its evolution is a great risk for all affected areas, as it can cause resistance to antibiotics.
7+
DNA is complex and mutations therein are varied and mostly unpredictable. Because of this, biogenetic researchers can often only rely on very limited automation. Their job involves detecting mutations and pinning down the root cause of them. Only in this way, can they completely annihilate the bacterium and nullify the Tuberculosis disease.
8+
9+
DNAv gives these researchers interactive, semantic and clearly visualized tools in their toolbox to help them with the detection and root cause analysis of these mutations.
10+
11+
### Documentation
12+
Documentation is currently stored under the `documentation` folder.
13+
14+
#### Testing documentation
15+
Documentation regarding testing can be found at `documentation/testing.md`.
16+
17+
### Building and running
18+
When the project is first cloned, you must run `mvn install` before any other lifecycle goals.
19+
#### Site generation
20+
To generate the site, run `mvn site:site site:stage`.
21+
22+
#### Packaging
23+
To create a single runnable jar use `mvn compile assembly:single` inside the `PL2` directory. The executable jar will then be located at `PL2-launcher/target/PL2-launcher-<VERSION>-jar-with-dependencies.jar`.
24+
25+
This jar can be than executed by double-clicking.
26+
27+
### Organization and Team
28+
DNAv is developed for the Contextproject course at the Delft University of Technology with course code TI2806, as part of the curriculum of the Bachelor Computer Science. The project is led by [Dr. Thomas Abeel](http://www.abeel.be/), who can be contacted by e-mail at [T.Abeel@tudelft.nl](mailto:T.Abeel@tudelft.nl).
29+
30+
#### Members
31+
- Wouter Smit
32+
- Cas Bilstra
33+
- Faris Elghlan
34+
- Justin van der Krieken
35+
- Casper Athmer

0 commit comments

Comments
 (0)