Meta: Symlink docs/relnotes/relnotes-2.0 to NEWS
[link.git] / INSTALL
bloba5df9c04eb32ea5a4824eff8c6d317f094e73af0
1                                -*-text-*-
3                             Link Installation
4                             =================
6 To build Link, it's just the normal 'cmake .. && make' and then 'make install'. 
7 Although, instead of using Make, we encourage you to use Ninja to build since it 
8 yields a faster build time:
10         $ mkdir build && cd build
11         $ cmake -GNinja ..
12         $ ninja && ninja install
14 By default, Link will be installed in /usr but you can easily change this just
15 by adding to the initial CMake command '-DCMAKE_INSTALL_PREFIX:PATH=/usr/local'
16 like so:
18         $ cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr/local ..
20 PREREQUISITES:
22 1. OpenSSL 3.x
24         OpenSSL 3.x is needed to use Link. You can grab a tarball from:
26                 https://github.com/openssl/openssl
28         Alternatively, you can install OpenSSL via your package manager of
29         choice. A quick issue to note is that certain distros (i.e. Ubuntu
30         20.10 and below) do not supply OpenSSL 3 in their repositories but
31         OpenSSL 1.1.1.
33 2. zlib
35         zlib is needed to use Link. You can grab a tarball from:
37                 https://zlib.net/
39         Alternatively, you can install zlib via your package manager of
40         choice. Contrary to OpenSSL, there's no reported issues with any
41         version of zlib.
43 3. glibc >=2.35
45 Please mail ~aristonl/link-discuss@lists.sr.ht if you have any issues.