@@ -6,7 +6,7 @@ can be used to build rich text-based user interfaces in any PHP application.
66> [ !NOTE]
77> Screen is a library intended to be integrated into PHP applications. It is not a standalone terminal application.
88
9- ## About Terminal Emulators
9+ ## About terminal emulators
1010
1111A terminal emulator is software that replicates the functionality of a classic hardware computer terminal. It processes
1212text input and output along with special control sequences (ANSI escape codes) that control formatting, cursor movement,
@@ -64,7 +64,7 @@ composer require soloterm/screen
6464- PHP 8.1 or higher
6565- mbstring extension
6666
67- ## Basic Usage
67+ ## Basic usage
6868
6969Here's a simple example of using Screen:
7070
@@ -84,7 +84,7 @@ $screen->write("\e[5;10HPositioned text");
8484echo $screen->output();
8585```
8686
87- ## Core Concepts
87+ ## Core concepts
8888
8989Screen operates with several key components:
9090
@@ -105,7 +105,7 @@ Screen uses multiple buffer types to track content and styling:
105105- ** PrintableBuffer** : Stores visible characters and handles width calculations
106106- ** AnsiBuffer** : Tracks styling information (colors, bold, underline, etc.)
107107
108- ### ANSI Processing
108+ ### ANSI processing
109109
110110Screen correctly handles ANSI escape sequences for:
111111
@@ -114,9 +114,9 @@ Screen correctly handles ANSI escape sequences for:
114114- Screen clearing and line manipulation
115115- Scrolling
116116
117- ## Advanced Features
117+ ## Advanced features
118118
119- ### Cursor Positioning
119+ ### Cursor positioning
120120
121121``` php
122122// Move cursor to position (row 5, column 10)
@@ -131,7 +131,7 @@ $screen->write("More text");
131131$screen->write("\e8"); // Restore
132132```
133133
134- ### Text Styling
134+ ### Text styling
135135
136136``` php
137137// Bold red text
@@ -147,7 +147,7 @@ $screen->write("\e[38;5;208mOrange text\e[0m");
147147$screen->write("\e[38;2;255;100;0mCustom color\e[0m");
148148```
149149
150- ### Screen Manipulation
150+ ### Screen manipulation
151151
152152``` php
153153// Clear screen
@@ -163,7 +163,7 @@ $screen->write("\e[2L");
163163$screen->write("\e[2S");
164164```
165165
166- ## Custom Integrations
166+ ## Custom integrations
167167
168168You can respond to terminal queries by setting a callback:
169169
@@ -177,7 +177,7 @@ $screen->respondToQueriesVia(function($response) {
177177> [ !NOTE]
178178> This is still a work in progress. We need some more tests / use cases here.
179179
180- ## Example: Building a Simple UI
180+ ## Example: building a simple UI
181181
182182``` php
183183use SoloTerm\Screen\Screen;
@@ -202,7 +202,7 @@ $screen->write("\e[7;5HPress 'q' to quit.");
202202echo $screen->output();
203203```
204204
205- ## Handling Unicode and Wide Characters
205+ ## Handling unicode and wide characters
206206
207207Screen properly handles Unicode characters including emoji and CJK characters that take up multiple columns:
208208
@@ -220,7 +220,7 @@ Screen includes a comprehensive testing suite that features a unique visual comp
220220composer test
221221```
222222
223- ### Visual Testing
223+ ### Visual testing
224224
225225Screen employs an innovative screenshot-based testing approach (see ` ComparesVisually ` trait) that validates the visual
226226output:
0 commit comments