textual icon indicating copy to clipboard operation
textual copied to clipboard

Minimal change to documentation

Open jsatchell opened this issue 2 months ago • 3 comments

Please review the following checklist. Small change to introduction of documentation, calling out to more detail in new Markdown file.

jsatchell avatar Nov 14 '25 13:11 jsatchell

Fixes issue #5011

jsatchell avatar Nov 19 '25 18:11 jsatchell

Happy with all of that, completely agree.

I will re-sync with main, make the suggested changes, and update the PR.

Thank you for your help.

On Sat, Dec 6, 2025 at 4:57 PM Will McGugan @.***> wrote:

@.**** requested changes on this pull request.

In docs/getting_started.md https://github.com/Textualize/textual/pull/6229#discussion_r2595114071:

@@ -3,14 +3,16 @@ All you need to get started building Textual apps.

Requirements

-Textual requires Python 3.9 or later (if you have a choice, pick the most recent Python). Textual runs on Linux, macOS, Windows and probably any OS where Python also runs. +Textual requires Python 3.9 or later (if you have a choice, pick the most recent Python). Textual runs on Linux, macOS, Windows and probably any OS where Python also runs. You also need a unicode font that includes the line drawing and block characters, which are used to render the controls.

This is going to confuse many developers who aren't familiar with these terms. I think we can drop this sentence.

In docs/getting_started.md https://github.com/Textualize/textual/pull/6229#discussion_r2595118861:

!!! info "Your platform"

 ### :fontawesome-brands-linux: Linux (all distros)

 All Linux distros come with a terminal emulator that can run Textual apps.
  • The linux console is more limited and not all fonts are suitable. See [Linux console]](./linux-console.md) for details.

May devs will not know the difference between the linux console and the terminal on their desktop.

Suggest clarification:

"If you are using the Linux console (rather than a desktop environment), see Linux Console ...]"

In docs/linux-console.md https://github.com/Textualize/textual/pull/6229#discussion_r2595127174:

@@ -0,0 +1,5 @@ +## Linux Console

+The Linux console has limited capabilities, to maintain back compatibility with legacy VGA hardware. It supports unicode but colours are restricted and the fonts have very limited numbers of glyphs. There is a choice of 256 glyphs with 16 colors or 512 glyphs with 8 colors. Textual really needs more than 8 colors, so a font with 256 glyphs is needed. The console uses fonts in a special PSF file type; these are often in the directory /usr/share/consolefonts/.

Sorry, but this copy is difficult to parse. Many people reading this will be far less technical that you.

Let's keep it simple. Something along these lines:

The Linux console is less graphically capable than the terminal emulator on your desktop. If you find your app does not look great with the default configuration, see font-for-textual https://github.com/jsatchell/font-for-textual for a possible solution.

You can be as technical as you like in your repo!

— Reply to this email directly, view it on GitHub https://github.com/Textualize/textual/pull/6229#pullrequestreview-3547902494, or unsubscribe https://github.com/notifications/unsubscribe-auth/AC4N6MFGSXUCS6WVTMVB5KL4AMDGRAVCNFSM6AAAAACMDYVK2OVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZTKNBXHEYDENBZGQ . You are receiving this because you authored the thread.Message ID: @.***>

jsatchell avatar Dec 06 '25 17:12 jsatchell

My head is updated with changes that, I hope, fix your concerns. Will also make sure the README for font-for-textual is as clear as possible!

jsatchell avatar Dec 06 '25 19:12 jsatchell