Skip to content

Commit

Permalink
Merge branch 'master' of github.com:mjoppich/bioGUI
Browse files Browse the repository at this point in the history
  • Loading branch information
mjoppich committed Jan 6, 2019
2 parents 1495a04 + e31f9ab commit e9ecf4b
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,15 @@

[![Documentation Status](https://readthedocs.org/projects/biogui/badge/?version=latest)](http://biogui.readthedocs.io/en/latest/?badge=latest)
[![Build Status](https://travis-ci.org/mjoppich/bioGUI.svg?branch=master)](https://travis-ci.org/mjoppich/bioGUI)
[![DOI](https://zenodo.org/badge/78450741.svg)](https://zenodo.org/badge/latestdoi/78450741)


With bioGUI developers can easily build a graphical-user-interface (GUI) for their command-line only application.
Such a GUI then enables many more people to use their software.
Especially in biology, the domain experts are often computer novices and have difficulties using tools written for them by bioinformaticiens/computer scientists.

You can find the corresponding [preprint at PeerJ](https://peerj.com/preprints/27095/).

## Who is bioGUI for?

With bioGUI domain experts, which have no clue about the command line, should be enabled to use highly sophisticated tools written for them.
Expand All @@ -18,6 +22,28 @@ With bioGUI one also does not need any knowledge about the command line, because

It is not about generating a GUI by its own.

# Where can I get bioGUI?

bioGUI is available either as source from github, or as prebuilt-binary distribution from [github releases](https://github.com/mjoppich/bioGUI/releases).
*End-users* will probably prefer to download and unzip the [prebuilt binaries](https://github.com/mjoppich/bioGUI/releases).

After downloading the zip-archive, please unzip the archive to a location of your preference. Then simply start the executable (bioGUI.exe on Windows, or bioGUI on linux).

On Windows, please follow the steps on [how to setup WSL](http://biogui.readthedocs.io/en/latest/build_wsl.html).

On any aptitude supported platform (Windows with WSL, Ubuntu), please execute the "First Time ... Setup" from the list of available templates.

Unfortunately, there currently is no binary available for Mac OS X.

## I want to know more about available modules

If you want to know which modules are already available, please visit the supporting information [website](https://www.bio.ifi.lmu.de/software/biogui/index.html). There you can see a list of available modules, submit your own or request new template.
If you have any problem, or you want to request a new template, you may also use the github issue tracker right in this repository!

## I want to know more about bioGUI

You can find a detailed documentation of bioGUI at [readthedocs](http://biogui.readthedocs.io/en/latest).

# About using/building bioGUI
## How to obtain bioGUI?

Expand Down

0 comments on commit e9ecf4b

Please sign in to comment.