From d2bddacacea1c12685637ab7fd5e78c7395dc776 Mon Sep 17 00:00:00 2001
From: Jakub Wilk <jwilk@jwilk.net>
Date: Wed, 24 Apr 2024 16:12:34 +0200
Subject: [PATCH] doc/README: move.

---
 .github/workflows/ci.yml |  2 +-
 README                   | 52 +---------------------------------------
 doc/README               | 51 +++++++++++++++++++++++++++++++++++++++
 3 files changed, 53 insertions(+), 52 deletions(-)
 mode change 100644 => 120000 README
 create mode 100644 doc/README

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 3c697e5..e269152 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -91,6 +91,6 @@ jobs:
     - name: check README syntax
       run: |
         python3 -m pip install restructuredtext-lint pygments
-        rst-lint --level=info --encoding=UTF-8 README
+        rst-lint --level=info --encoding=UTF-8 doc/README
 
 # vim:ts=2 sts=2 sw=2 et
diff --git a/README b/README
deleted file mode 100644
index a1fba15..0000000
--- a/README
+++ /dev/null
@@ -1,51 +0,0 @@
-Overview
-========
-
-.. code:: console
-
-   $ ubanner --help
-   usage: ubanner [-h] [--version] [--list-fonts] [--trim] [-f FONT] [-s N] [-S]
-                  [TEXT ...]
-
-   positional arguments:
-     TEXT
-
-   options:
-     -h, --help            show this help message and exit
-     --version             show version information and exit
-     --list-fonts          print list of available font faces
-     --trim                trim leading/trailing empty lines
-     -f FONT, --font FONT  use this font face
-     -s N, --font-size N   font size in pixels (default: 28)
-     -S, --full-screen     max font size to fit terminal window
-
-   $ ubanner -f 'DejaVu Sans' -s 32 'd͡ʒ'
-                ░░░▒▒▒▒▒▒▒▒░░░
-           ░▒█████▒▒▒▒▒▒▒▒▒▒█████▒░
-         ██▒░                   ░░▒██
-                 ░██░
-                 ░██░
-                 ░██░
-        ▒██████▒ ░██░   ░█████████████░
-      ▒███░░ ░░▒████░             ▒███
-     ▒██▒       ░███░            ███▒
-     ███         ▒██░          ░███
-     ███         ░██░         ███░
-     ███         ▒██░       ░███▒░░
-     ▒██▒       ░███░       ░████████░
-      ▒███░░ ░░▒████░              ▒███
-        ▒██████▒ ░██░               ▒██▒
-                                    ▒██▒
-                        ░░         ▒███
-                        ▒████████████░
-                           ░░░░░░░░
-
-Dependencies
-============
-
-* Python (≥ 3.6)
-* PyGI
-* Pango GIR bindings
-* Pycairo (≥ 1.11)
-
-.. vim:ft=rst ts=3 sts=3 sw=3 et
diff --git a/README b/README
new file mode 120000
index 0000000..4baf228
--- /dev/null
+++ b/README
@@ -0,0 +1 @@
+doc/README
\ No newline at end of file
diff --git a/doc/README b/doc/README
new file mode 100644
index 0000000..a1fba15
--- /dev/null
+++ b/doc/README
@@ -0,0 +1,51 @@
+Overview
+========
+
+.. code:: console
+
+   $ ubanner --help
+   usage: ubanner [-h] [--version] [--list-fonts] [--trim] [-f FONT] [-s N] [-S]
+                  [TEXT ...]
+
+   positional arguments:
+     TEXT
+
+   options:
+     -h, --help            show this help message and exit
+     --version             show version information and exit
+     --list-fonts          print list of available font faces
+     --trim                trim leading/trailing empty lines
+     -f FONT, --font FONT  use this font face
+     -s N, --font-size N   font size in pixels (default: 28)
+     -S, --full-screen     max font size to fit terminal window
+
+   $ ubanner -f 'DejaVu Sans' -s 32 'd͡ʒ'
+                ░░░▒▒▒▒▒▒▒▒░░░
+           ░▒█████▒▒▒▒▒▒▒▒▒▒█████▒░
+         ██▒░                   ░░▒██
+                 ░██░
+                 ░██░
+                 ░██░
+        ▒██████▒ ░██░   ░█████████████░
+      ▒███░░ ░░▒████░             ▒███
+     ▒██▒       ░███░            ███▒
+     ███         ▒██░          ░███
+     ███         ░██░         ███░
+     ███         ▒██░       ░███▒░░
+     ▒██▒       ░███░       ░████████░
+      ▒███░░ ░░▒████░              ▒███
+        ▒██████▒ ░██░               ▒██▒
+                                    ▒██▒
+                        ░░         ▒███
+                        ▒████████████░
+                           ░░░░░░░░
+
+Dependencies
+============
+
+* Python (≥ 3.6)
+* PyGI
+* Pango GIR bindings
+* Pycairo (≥ 1.11)
+
+.. vim:ft=rst ts=3 sts=3 sw=3 et