Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MarvinDo authored Nov 17, 2024
1 parent c4ce76a commit 4267a8a
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ The live version is hosted by the university of cologne: [https://heredivar.uni-

Further details about the features of HerediVar can be found here: [https://heredivar.uni-koeln.de/documentation](https://heredivar.uni-koeln.de/documentation)

![infrastructure](https://github.com/GC-HBOC/HerediVar/blob/main/doc/img/Infrastructure.png?raw=true)

## Tooling
HerediVar uses the following tools:
- Operating System: tested on Linux Ubuntu 20.04
Expand All @@ -26,6 +24,9 @@ HerediVar uses the following tools:
- Database: MariaDB (v.10.3.39)
- Tests: PyTest (v.8.2.2) and Playwright (v.1.45.0)

On a high level, the HerediVar infrastructure looks like this:
![infrastructure](https://github.com/GC-HBOC/HerediVar/blob/main/doc/img/Infrastructure.png?raw=true)

## Installation
The HerediVar installation is quite lengthy, because it requires a lot of data and tools. It is recommended that you have at least 500 GB of free disk space to install HerediVar. HerediVar was developed and tested on Linux Ubuntu 20.04. So the following steps assume you are using this operating system. (There is however a good chance that HerediVar will work properly on any operating system, but you might need to adjust the installation scripts.)

Expand Down

0 comments on commit 4267a8a

Please sign in to comment.