README.md

   1 # Link
   2 Link is a web server library for C++ built with a focus of speed.
   3 <br>
   4 The source to Link is mainly written by Levi Hicks with help from Ariston Lorenzo
   5 in maintainership and documentation. Link is a N11 project.
   6
   7 ## Getting Link
   8 You can find the Link repository at multiple places. These are all the current
   9 repositories.
  10
  11         GitHub (N11): https://github.com/n11software/link.git
  12         GitHub (aristonl): https://github.com/aristonl/link.git
  13         repo.or.cz (aristonl): git://repo.or.cz/link.git
  14         Codeberg (aristonl): https://codeberg.org/atl/link.git
  15         SourceHut (N11/aristonl): https://git.sr.ht/~aristonl/link.git
  16
  17 ## Build and Install Link
  18 Make sure you install CMake, GCC, zlib, and OpenSSL version >=3.
  19
  20         $ mkdir build && cd build
  21         $ cmake ..
  22         $ make && sudo make install
  23
  24 See INSTALL for in-depth installation instructions.
  25
  26 ## Using Link
  27 You can find a Link website template at [aristonl/linkproj](https://github.com/aristonl/linkproj).
  28 See its README for more information.
  29 <br>
  30 See docs/beginners-guide.md for more information on using Link.
  31
  32 ## Support
  33 You can email ~aristonl/link-discuss@lists.sr.ht for any user discussion and
  34 issue reports (excluding security vulnerabilities, see docs/security.md). All
  35 patches and pull requests can be sent to ~aristonl/link-devel@lists.sr.ht.
  36
  37 ## Credits
  38 See CREDITS.
  39
  40 ## Contributing
  41 See docs/contributing
  42
  43 ## License
  44 Link is licensed under the BSD 3-Clause License. See COPYRIGHT for more information.