Skip to content

Commit

Permalink
doc/README: move.
Browse files Browse the repository at this point in the history
  • Loading branch information
jwilk committed Apr 24, 2024
1 parent 8bae16d commit d2bddac
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 52 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
51 changes: 0 additions & 51 deletions README

This file was deleted.

1 change: 1 addition & 0 deletions README
51 changes: 51 additions & 0 deletions doc/README
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit d2bddac

Please sign in to comment.