summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJaakko Keränen <jaakko.keranen@iki.fi>2020-10-16 19:04:34 +0300
committerJaakko Keränen <jaakko.keranen@iki.fi>2020-10-16 19:04:34 +0300
commit92c6007fe54410dfe097ff493fdc86ad2847857a (patch)
tree50fd32ab5d85c4c691041e5329374cf0e58fd0c7 /README.md
parent3d723de1022d2fdeccb9bae6f934e6936445ef21 (diff)
Updated README
Added mention of optional mpg123 decoder library.
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/README.md b/README.md
index 89cd8e55..95767aee 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,7 @@ Like Gemini, Lagrange has been designed with minimalism in mind. It depends on a
14* Sidebar for page outline, managing bookmarks and identities, and viewing history 14* Sidebar for page outline, managing bookmarks and identities, and viewing history
15* Multiple tabs 15* Multiple tabs
16* Identity management — create and use TLS client certificates 16* Identity management — create and use TLS client certificates
17* Audio playback: MP3, Ogg Vorbis, WAV
17* And more! Open `about:help` in the app, or see [help.gmi](https://git.skyjake.fi/skyjake/lagrange/raw/branch/release/res/about/help.gmi) 18* And more! Open `about:help` in the app, or see [help.gmi](https://git.skyjake.fi/skyjake/lagrange/raw/branch/release/res/about/help.gmi)
18 19
19## Downloads 20## Downloads
@@ -25,11 +26,12 @@ Prebuilt binaries for Windows and macOS can be found in [Releases][rel].
25This 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`. 26This 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`.
26 27
271. Download and extract a source tarball from [Releases][rel]. Alternatively, you may also clone the repository and its submodules: `git clone --recursive --branch release https://git.skyjake.fi/skyjake/lagrange` 281. Download and extract a source tarball from [Releases][rel]. Alternatively, you may also clone the repository and its submodules: `git clone --recursive --branch release https://git.skyjake.fi/skyjake/lagrange`
282. 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``` 292. Check that you have the required 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```
293. Create a build directory. 303. Optionally, install the mpg123 decoder library for MPEG audio support. For example, the macOS Homebrew package is `mpg123` and on Ubuntu it is `libmpg123-dev`.
304. In your empty build directory, run CMake: ```cmake {path_of_lagrange_sources} -DCMAKE_BUILD_TYPE=Release``` 314. Create a build directory.
315. Build it: ```cmake --build .``` 325. In your empty build directory, run CMake: ```cmake {path_of_lagrange_sources} -DCMAKE_BUILD_TYPE=Release```
326. Now you can run `lagrange`, `lagrange.exe`, or `Lagrange.app`. 336. Build it: ```cmake --build .```
347. Now you can run `lagrange`, `lagrange.exe`, or `Lagrange.app`.
33 35
34### Installing to a directory 36### Installing to a directory
35 37