README

   1
   2                        Link - a web server library for C++
   3         Copyright (c) 2021, 2022, 2023 N11 Software. All rights reserved.
   4
   5 --------------------------------------------------------------------------------
   6
   7 WHAT'S LINK
   8
   9         Link is a web server library for C++ built with a focus of speed.
  10
  11         The source to Link is mainly written by Levi Hicks with help from
  12         Ariston Lorenzo in maintainership and documentation. Link is a N11
  13         project.
  14
  15 --------------------------------------------------------------------------------
  16
  17 GETTING SOURCES:
  18
  19         You can find the Link repository at multiple places. These are all the
  20         repositories.
  21
  22         GitHub (N11): https://github.com/n11software/link.git
  23         GitHub (aristonl): https://github.com/aristonl/link.git
  24         repo.or.cz (aristonl): git://repo.or.cz/link.git
  25         Codeberg (aristonl): https://codeberg.org/atl/link.git
  26         SourceHut (N11/aristonl): https://git.sr.ht/~aristonl/link.git
  27
  28 --------------------------------------------------------------------------------
  29
  30 INSTALLING:
  31
  32         Make sure you install CMake, GCC, zlib, and OpenSSL version >=3.
  33
  34                 $ mkdir build && cd build
  35                 $ cmake ..
  36                 $ make && sudo make install
  37
  38         See INSTALL for in-depth installation instructions.
  39
  40 --------------------------------------------------------------------------------
  41
  42 USAGE:
  43
  44         You can find a Link website template at aristonl/linkproj on GitHub or
  45         at git.sr.ht/~aristonl/linkproj.
  46         See its README for more information.
  47
  48         See docs/beginners-guide.md for more information on using Link.
  49
  50 --------------------------------------------------------------------------------
  51
  52 MAILING LISTS:
  53
  54         You can email ~aristonl/link-discuss@lists.sr.ht for any user
  55         discussion and issue reports (excluding security vulnerabilities, see
  56         docs/security.md). All patches and pull requests can be sent to
  57         ~aristonl/link-devel@lists.sr.ht.
  58
  59 --------------------------------------------------------------------------------
  60
  61 CREDITS:
  62
  63         See CREDITS.
  64
  65 --------------------------------------------------------------------------------
  66
  67 Copyright (c) 2021, 2022, 2023 N11 Software. All rights reserved.
  68
  69 This software is open source software; you can modify it and/or distribute it
  70 under the terms of the BSD 3-Clause License (Modified BSD License) as published
  71 with the distribution of this software.
  72
  73 This program is distributed WITHOUT ANY WARRANTY; without even the implied
  74 warranty of MERCHANTABILITY or FITENSS FOR A PARTICULAR PURPOSE.  See the
  75 BSD 3-Clause License in the file COPYRIGHT for more details.
  76
  77 You should have recieved a copy of the BSD 3-Clause License with this program.
  78 If not, see the following pages:
  79
  80         <https://opensource.org/license/bsd-3-clause/>.