From a2e5682dd34deb17bedf6b9bf2f4266fd23bab19 Mon Sep 17 00:00:00 2001 From: nick black Date: Wed, 27 Oct 2021 20:36:07 -0400 Subject: [PATCH] [README] need html syntax in FAQ --- README.md | 44 +++++++++++++++++++++++--------------------- 1 file changed, 23 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 290bafa6b..0eab6b33c 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,6 @@ most of the functionality of Notcurses. ![FreeBSD](https://img.shields.io/badge/-FreeBSD-grey?logo=freebsd) ![Windows](https://img.shields.io/badge/-Windows-grey?logo=windows) ![macOS](https://img.shields.io/badge/-macOS-grey?logo=macos) -[![Matrix](https://img.shields.io/matrix/notcursesdev:matrix.org?label=matrixchat)](https://app.element.io/#/room/#notcursesdev:matrix.org) [![Linux](https://github.com/dankamongmen/notcurses/actions/workflows/ubuntu_test.yml/badge.svg?branch=master)](https://github.com/dankamongmen/notcurses/actions/workflows/ubuntu_test.yml?query=branch%3Amaster) [![macOS](https://github.com/dankamongmen/notcurses/actions/workflows/macos_test.yml/badge.svg?branch=master)](https://github.com/dankamongmen/notcurses/actions/workflows/macos_test.yml?query=branch%3Amaster) @@ -44,6 +43,7 @@ most of the functionality of Notcurses. [![pypi_version](https://img.shields.io/pypi/v/notcurses?label=pypi)](https://pypi.org/project/notcurses) [![crates.io](https://img.shields.io/crates/v/libnotcurses-sys.svg)](https://crates.io/crates/libnotcurses-sys) +[![Matrix](https://img.shields.io/matrix/notcursesdev:matrix.org?label=matrixchat)](https://app.element.io/#/room/#notcursesdev:matrix.org) [![Sponsor](https://img.shields.io/badge/-Sponsor-red?logo=github)](https://github.com/sponsors/dankamongmen) ## Introduction @@ -243,8 +243,8 @@ If things break or seem otherwise lackluster, **please** consult the with Notcurses? Yes! Use the flags NCOPTION_NO_ALTERNATE_SCREEN, NCOPTION_NO_CLEAR_BITMAPS, and NCOPTION_PRESERVE_CURSOR, - and call `ncplane_set_scrolling()` on the standard plane. You still must - explicitly render. + and call ncplane_set_scrolling() on the standard plane. You + still must explicitly render.
@@ -268,26 +268,28 @@ If things break or seem otherwise lackluster, **please** consult the Some of it! You won't be able to build several binaries, nor the NCPP C++ wrappers, nor can you build with the OpenImageIO multimedia backend (OIIO ships C++ headers). You'll be able to build the main library, though, as - well as `notcurses-demo` (and maybe a few other binaries). + well as notcurses-demo (and maybe a few other binaries).
Does it work with hardware terminals? - With the correct `TERM` value, many hardware terminals are supported. The VT100 - is sadly unsupported due to its extensive need for delays. In general, if the - terminfo database entry indicates mandatory delays, Notcurses will not currently - support that terminal properly. It's known that Notcurses can drive the VT320 - and VT340, including Sixel graphics on the latter. + With the correct TERM value, many hardware terminals are + supported. The VT100 is sadly unsupported due to its extensive need for + delays. In general, if the terminfo database entry indicates mandatory + delays, Notcurses will not currently support that terminal properly. It's + known that Notcurses can drive the VT320 and VT340, including Sixel graphics + on the latter.
What happens if I try blitting bitmap graphics on a terminal which doesn't support them? Notcurses will not make use of bitmap protocols unless the terminal positively - indicates support for them, even if `NCBLIT_PIXEL` has been requested. Likewise, - sextants (`NCBLIT_3x2`) won't be used without Unicode 13 support, etc. - `ncvisual_blit()` will use the best blitter available, unless - `NCVISUAL_OPTION_NODEGRADE` is provided (in which case it will fail). + indicates support for them, even if NCBLIT_PIXEL has been + requested. Likewise, sextants (NCBLIT_3x2) won't be used without + Unicode 13 support, etc. ncvisual_blit() will use the best blitter + available, unless NCVISUAL_OPTION_NODEGRADE is provided (in + which case it will fail).
@@ -309,8 +311,8 @@ If things break or seem otherwise lackluster, **please** consult the Go to [Language Settings](ms-settings:regionlanguage), click "Administrative language settings", click "Change system locale", and check the "Beta: Use Unicode UTF-8 for worldwide language support" option. Restart the computer. - That ought help a little bit. Ensure your code page is 65001 with `chcp 65001`. - Try playing with fonts. + That ought help a little bit. Ensure your code page is 65001 with + chcp 65001. Try playing with fonts.
@@ -318,8 +320,8 @@ If things break or seem otherwise lackluster, **please** consult the Notcurses supports Kitty's powerful [keyboard protocol](https://sw.kovidgoyal.net/kitty/keyboard-protocol/), which includes things like key release events and modifier keypresses by themselves. This means, among other things, that a program in Kitty will - usually immediately get an `NC_ENTER` `NCTYPE_RELEASE` event, and each - keypress will typically result in at least two inputs. + usually immediately get an NC_ENTER NCTYPE_RELEASE + event, and each keypress will typically result in at least two inputs.
@@ -422,7 +424,7 @@ If things break or seem otherwise lackluster, **please** consult the
How can I use Direct Mode in conjunction with libreadline? You can't anymore (you could up until 2.4.1, but the new input system is - fundamentally incompatible with it). `ncdirect_readline()` still exists, + fundamentally incompatible with it). ncdirect_readline() still exists, though, and now actually works even without libreadline, though it is of course not exactly libreadline. In any case, you'd probably be better off using CLI mode with a ncreader. @@ -480,8 +482,8 @@ If things break or seem otherwise lackluster, **please** consult the Notcurses exits immediately in MSYS2/Cygwin. Notcurses requires the [Windows ConPTY](https://devblogs.microsoft.com/commandline/windows-command-line-introducing-the-windows-pseudo-console-conpty/) layer. This is available in Cygwin by default since 3.2.0, but is disabled - by default in MSYS. Launch `mintty` with `-P on` arguments, or export - `MSYS=enable_pcon` before launching it. + by default in MSYS. Launch mintty with -P on + arguments, or export MSYS=enable_pcon before launching it.
@@ -534,7 +536,7 @@ If things break or seem otherwise lackluster, **please** consult the
- I get a `NCKEY_ENTER` immediately after launching a Notcurses + I get a NCKEY_ENTER immediately after launching a Notcurses program, but I didn't press Enter. When the Kitty keyboard disambiguation protocol is in use, events are generated for both the press and release of keys. If you launched