From 1102f13c4254cd63b83605b2a5789969fed0944e Mon Sep 17 00:00:00 2001 From: Jaakko Keränen Date: Mon, 14 Sep 2020 14:55:33 +0300 Subject: Updated README Specified required OpenSSL version and added a note about git submodules. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 83e9a6e9..e8395f49 100644 --- a/README.md +++ b/README.md @@ -24,8 +24,8 @@ Prebuilt binaries for Windows and macOS can be found in [Releases][rel]. This is how to build Lagrange in a Unix-like environment. The required tools are a C11 compiler (e.g., Clang or GCC), CMake and `pkg-config`. -1. Download and extract a source tarball from [Releases][rel]. (If you just clone this Git repository, [the_Foundation][tf] is expected to be already available on the system.) -2. Check that you have the dependencies installed: SDL2, OpenSSL, libpcre, zlib, libunistring. For example, on macOS this would do the trick (using Homebrew): ```brew install sdl2 openssl@1.1 pcre libunistring``` Or on Ubuntu: ```sudo apt install libsdl2-dev libssl-dev libpcre3-dev zlib1g-dev libunistring-dev``` +1. Download and extract a source tarball from [Releases][rel]. Alternatively, you may also clone the repository and its submodules: `git clone --recursive https://git.skyjake.fi/skyjake/lagrange.git` +2. Check that you have the dependencies installed: CMake, SDL 2, OpenSSL 1.1.1, libpcre, zlib, libunistring. For example, on macOS this would do the trick (using Homebrew): ```brew install cmake sdl2 openssl@1.1 pcre libunistring``` Or on Ubuntu: ```sudo apt install cmake libsdl2-dev libssl-dev libpcre3-dev zlib1g-dev libunistring-dev``` 3. Create a build directory. 4. In your empty build directory, run CMake: ```cmake {path_of_lagrange_sources}``` 5. Built it: ```cmake --build .``` -- cgit v1.2.3