Verified Commit 57366c5c authored by Raphaël Flores's avatar Raphaël Flores
Browse files

Add requirements section in the README.

parent 93b1843d
......@@ -5,6 +5,7 @@
- [Data](#data)
- [Code](#code)
- [Setup](#setup)
- [Requirements](#requirements)
- [Data handling](#data-handling)
- [Backend](#backend)
- [Frontend](#frontend)
......@@ -31,6 +32,20 @@ If you do want to contribute to code, that's great also, have a look at [CONTRIB
## Setup
### Requirements
The application itself is running under a Java OpenJDK 8+: <https://openjdk.java.net/install/>
For getting the data, you need to install Git LFS: <https://git-lfs.github.com/>
The indexing process depends on the following tools, you need to have them installed and available in your `PATH` variable:
- JQ 1.6+: <https://stedolan.github.io/jq/>
- GNU Parallel (recent enough version): <https://www.gnu.org/software/parallel/>
- GNU coreutils (sed, date...): <https://www.gnu.org/software/coreutils/>
- GNU GZIP: <https://git.savannah.gnu.org/cgit/gzip.git>
- GNU Bash v4+: <https://www.gnu.org/software/bash/>
### Data handling
At the moment, all data is located next to the code in the `data` directory. If you want to have a look at the code only, you can ignore this directory at git clone step by setting the variable `GIT_LFS_SKIP_SMUDGE=1`, ie.:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment