@@ -10,12 +10,49 @@ This is a module of [Bearsampp project](https://github.com/bearsampp/bearsampp)
1010## Overview
1111
1212This module provides PowerShell 7+ with enhanced console features including:
13- - ** Clink** - Powerful command-line completion and editing
14- - ** Clink-completions** - Extended completion scripts for common commands
1513- ** Oh My Posh** - Beautiful and customizable prompt themes
14+ - ** PSReadLine** - Advanced command-line editing and history
15+ - ** Nerd Fonts** - Rich icon and glyph support
1616
1717This module provides automated building and packaging for Bearsampp.
1818
19+ ### Font Requirement
20+
21+ This PowerShell module requires a ** Nerd Font** to display Oh My Posh icons and glyphs correctly.
22+
23+ #### Required Font
24+ - ** Font Name** : CaskaydiaCove NF (Cascadia Code Nerd Font)
25+ - ** Installation** : Should be installed system-wide via Bearsampp prerequisites
26+
27+ #### Configuring the Font
28+
29+ ** Windows Terminal (Recommended)**
30+
31+ If using Windows Terminal, add this to your ` settings.json ` :
32+
33+ ``` json
34+ {
35+ "profiles" : {
36+ "defaults" : {
37+ "font" : {
38+ "face" : " CaskaydiaCove NF" ,
39+ "size" : 10
40+ }
41+ }
42+ }
43+ }
44+ ```
45+
46+ ** Windows Console Host (conhost.exe)**
47+ 1 . Right-click the title bar → Properties
48+ 2 . Go to the Font tab
49+ 3 . Select "CaskaydiaCove NF" from the font list
50+ 4 . Click OK
51+
52+ ** PowerShell Console**
53+
54+ The font is automatically used if it's set as the default console font in Windows.
55+
1956### Build System
2057
2158- ** Pure Gradle Build** : Modern build automation with no Ant dependencies
@@ -110,8 +147,6 @@ bundle.format = 7z # Archive format (7z or zip)
110147Dependencies configuration for each version (located in ` bin/shell{version}/deps.properties ` ):
111148
112149``` properties
113- clink = https://github.com/Bearsampp/modules-untouched/releases/download/Cmder-2025.11.25/clink.1.9.2.6aa2e0.zip
114- clink_completions = https://github.com/Bearsampp/modules-untouched/releases/download/Cmder-2025.11.25/clink-completions-0.6.7.zip
115150oh_my_posh = https://github.com/Bearsampp/modules-untouched/releases/download/Cmder-2025.11.25/posh-windows-amd64.exe
116151oh_my_posh_theme = https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/paradox.omp.json
117152```
@@ -193,10 +228,44 @@ C:/Bearsampp-build/
193228
194229### Enhanced Console Features
195230
196- - ** Clink Integration** : Powerful bash-style command-line editing
197- - ** Auto-completion** : Intelligent command and path completion
198231- ** Oh My Posh Themes** : Beautiful, customizable prompt themes
232+ - ** PSReadLine** : Advanced command-line editing with syntax highlighting
233+ - ** Auto-completion** : Intelligent command and path completion
199234- ** Command History** : Persistent command history across sessions
235+ - ** Nerd Font Icons** : Rich visual indicators and glyphs
236+
237+ ### Configuration Files
238+
239+ - ** Microsoft.PowerShell_profile.ps1** - Main PowerShell profile
240+ - Configures PSReadLine (command-line editing)
241+ - Initializes Oh My Posh with paradox theme
242+ - Sets up history and key bindings
243+ - Requires CaskaydiaCove NF font for proper icon display
244+
245+ ### Environment Variables
246+
247+ The profile sets these environment variables:
248+ - ` POSH_ROOT ` - Path to Oh My Posh installation
249+ - ` POSH_THEMES_PATH ` - Path to Oh My Posh themes directory
250+
251+ ### Customization
252+
253+ ** Change Oh My Posh Theme**
254+
255+ Edit the profile and change the theme file:
256+ ``` powershell
257+ $ohMyPoshTheme = Join-Path $env:POSH_ROOT "themes\YOUR_THEME.omp.json"
258+ ```
259+
260+ Available themes are in ` vendor/oh-my-posh/themes/ `
261+
262+ ** Modify PSReadLine Settings**
263+
264+ Edit the ` Set-PSReadLineOption ` calls in the profile to customize:
265+ - Colors
266+ - Key bindings
267+ - History behavior
268+ - Prediction settings
200269
201270### Build Features
202271
@@ -224,13 +293,3 @@ This project deliberately does not ship the Gradle Wrapper. Install Gradle 8+ lo
224293## Issues
225294
226295Issues must be reported on [ Bearsampp repository] ( https://github.com/bearsampp/bearsampp/issues ) .
227-
228- ## Sponsors
229-
230- We would like to thank our sponsors to the project:
231-
232- [ N6REJ] ( https://github.com/N6REJ ) <br />
233-
234- <img src =" https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png " width =" 80 " >
235-
236- [ ![ Code Shelter] ( https://www.codeshelter.co/static/badges/badge-flat.svg )] ( https://www.codeshelter.co/ )
0 commit comments