Lady’s Gitweb - Git/blob - README.markdown

   1 <!--
   2 SPDX-FileCopyrightText: 2024 Lady <https://www.ladys.computer/about/#lady>
   3 SPDX-License-Identifier: CC0-1.0
   4 -->
   5 # Lady’s Gitweb
   6
   7 This repository contains the source code for [Lady’s Gitweb
   8   instance][Git].
   9 For more information, see [the Gitweb documentation][gitweb].
  10
  11 ## Overview of Files
  12
  13 ### Files Generated as Part of Gitweb Installation
  14
  15 The following files were created when installing Gitweb for the first
  16   time, and consequently were primarily authored by other people.
  17
  18 - **`gitweb.cgi`:**
  19   The Gitweb C·G·I script.
  20
  21 - **`static/gitweb.css`:**
  22   The C·S·S styling provided with Gitweb.
  23
  24 - **`static/gitweb.js`:**
  25   The Javascript provided with GitWeb.
  26   This file was originally built from a catenation of multiple source
  27     files.
  28
  29 ### Files from Other Sources
  30
  31 - **`markdown.js`, `markdown.js.map`, and `markdown.wasm`:**
  32   These files provide version 1.2.0 of [Rasmus Andersson’s Web·assembly
  33     Markdown parser][markdown-wasm], used to dynamically render
  34     Markdown on the client.
  35
  36 ### Additional Files
  37
  38 These files were created by Lady.
  39
  40 - **`git-favicon.png`:**
  41   The site favicon.
  42
  43 - **`git-logo.png`:**
  44   The site’s 27×72 button.
  45
  46 - **`gitweb_config.perl`:**
  47   Configuration for `gitweb.cgi`.
  48
  49 - **`mime.types`:**
  50   Additional media types which Gitweb should support.
  51
  52 - **`post-receive`:**
  53   A post⹀receive hook for updating a Gitweb installation at
  54     `/var/www/gitweb` upon changes to the `live` branch of this
  55     repository.
  56
  57 ## License
  58
  59 This repository conforms to [REUSE][].
  60
  61 This repository contains a number of files from different locations and
  62   made available under different licenses, so it is necessary to check
  63   the comment header to determine the license associated with the code.
  64 For some files which were programmatically generated, there may not be
  65   a comment header; in these cases one must check the accompanying
  66   `.license` file.
  67
  68 Note that the list of code authors provided in REUSE headers only
  69   includes those which were originally listed in the source files, and
  70   may be incomplete (for example; many contributors to Gitweb did not
  71   bother updating the copyright notices on the files they touched).
  72 You should assume that there may be additional copyright holders for
  73   any code which did not originate with Lady.
  74
  75 [Git]: <https://git.ladys.computer/>
  76 [REUSE]: <https://reuse.software/>
  77 [gitweb]: <https://git-scm.com/docs/gitweb>
  78 [markdown-wasm]: <https://rsms.me/markdown-wasm/>