diff --git a/README.md b/README.md index 423129d..e813759 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,23 @@ This repo houses the library behind Feader. The idea behind the project is to se ## Configuring the Environment -On Ubuntu, run the following: +### Ubuntu + +Install the following packages ``` -sudo apt install cmake libcurl3-openssl-dev libxml2-dev libsqlite3-dev +cmake libcurl3-openssl-dev libxml2-dev libsqlite3-dev ``` +OR run the configure script: + +``` +./configure +``` + +### Windows + WIP + ## Building Clone the repo, then run the following: @@ -28,4 +39,4 @@ make [ ] Write Android client [ ] Write Windows 10 client OR Java client [ ] Write GTK client (if not Java client) -[ ] Write Mac client (if not Java client) \ No newline at end of file +[ ] Write Mac client (if not Java client) diff --git a/configure b/configure new file mode 100755 index 0000000..65a0d8b --- /dev/null +++ b/configure @@ -0,0 +1,14 @@ +#!/bin/bash + +source /etc/os-release + +if [ "$ID" != "ubuntu" ]; then + echo "Unsupported build system. \ + Please try on Ubuntu, or modify the script to support your system."; + exit 1; +fi + +sudo apt install -y cmake libcurl3-openssl-dev libsqlite3-dev libxml2-dev + +test -d build && rm -rf build +mkdir build