Skip to content

Commit 4ed6378

Browse files
committed
README
1 parent a85f44b commit 4ed6378

1 file changed

Lines changed: 11 additions & 10 deletions

File tree

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -486,7 +486,7 @@ print(pointers)
486486

487487
Output:
488488

489-
```py
489+
```sh
490490
[{'modified': 1695535334.1411633, 'created': 1697604128.7045012, 'access': 1697604129.781534, 'name': 'CLI.py', 'size': 3345, 'abspath': '/Users/YOU/Downloads/CLI.py', 'dirname': '/Users/YOU/Downloads', 'is_dir': False, 'is_file': True, 'is_link': False, 'exists': True, 'extension': 'py'}, {'modified': 1697605101.6574, 'created': 1697683292.4821024, 'access': 1697683294.46923, 'name': 'Python_Logo.png', 'size': 747809, 'abspath': '/Users/YOU/Downloads/Python_Logo.png', 'dirname': '/Users/YOU/Downloads', 'is_dir': False, 'is_file': True, 'is_link': False, 'exists': True, 'extension': 'png'}, {'modified': 1697681746.0940206, 'created': 1697682027.268841, 'access': 1697682292.5433743, 'name': 'Sample_File.py', 'size': 1031, 'abspath': '/Users/YOU/Downloads/Sample_File.py', 'dirname': '/Users/YOU/Downloads', 'is_dir': False, 'is_file': True, 'is_link': False, 'exists': True, 'extension': 'py'}]
491491
```
492492

@@ -501,7 +501,7 @@ py_files = [x for x in pointers if x["extension"] == "py"]
501501
print(py_files)
502502
```
503503

504-
```py
504+
```sh
505505
[{'modified': 1695535334.1411633, 'created': 1697604128.7045012, 'access': 1697604129.781534, 'name': 'CLI.py', 'size': 3345, 'abspath': '/Users/YOU/Downloads/CLI.py', 'dirname': '/Users/YOU/Downloads', 'is_dir': False, 'is_file': True, 'is_link': False, 'exists': True, 'extension': 'py'}, {'modified': 1697681746.0940206, 'created': 1697682027.268841, 'access': 1697681829.0075543, 'name': 'Sample_File.py', 'size': 1031, 'abspath': '/Users/YOU/Downloads/Sample_File.py', 'dirname': '/Users/YOU/Downloads', 'is_dir': False, 'is_file': True, 'is_link': False, 'exists': True, 'extension': 'py'}]
506506
```
507507

@@ -533,7 +533,7 @@ print(tree)
533533

534534
Output:
535535

536-
```py
536+
```sh
537537
[{'modified': 1697683292.4821026, 'created': 1697683292.4821026, 'access': 1697683292.484029, 'name': 'Downloads', 'size': 224, 'abspath': '/Users/YOU/Downloads', 'dirname': '/Users/YOU', 'is_dir': True, 'is_file': False, 'is_link': False, 'exists': True, 'extension': ''}, {'modified': 1697683288.8639557, 'created': 1697683288.8639557, 'access': 1697602943.1846778, 'name': '.DS_Store', 'size': 6148, 'abspath': '/Users/YOU/Downloads/.DS_Store', 'dirname': '/Users/YOU/Downloads', 'is_dir': False, 'is_file': True, 'is_link': False, 'exists': True, 'extension': 'DS_Store'}, {'modified': 1690685751.342114, 'created': 1690685751.4194765, 'access': 1690685751.342114, 'name': '.localized', 'size': 0, 'abspath': '/Users/YOU/Downloads/.localized', 'dirname': '/Users/YOU/Downloads', 'is_dir': False, 'is_file': True, 'is_link': False, 'exists': True, 'extension': 'localized'}, {'modified': 1695535334.1411633, 'created': 1697604128.7045012, 'access': 1697604129.781534, 'name': 'CLI.py', 'size': 3345, 'abspath': '/Users/YOU/Downloads/CLI.py', 'dirname': '/Users/YOU/Downloads', 'is_dir': False, 'is_file': True, 'is_link': False, 'exists': True, 'extension': 'py'}, {'modified': 1697605101.6574, 'created': 1697683292.4821024, 'access': 1697683294.46923, 'name': 'Python_Logo.png', 'size': 747809, 'abspath': '/Users/YOU/Downloads/Python_Logo.png', 'dirname': '/Users/YOU/Downloads', 'is_dir': False, 'is_file': True, 'is_link': False, 'exists': True, 'extension': 'png'}, {'modified': 1697681746.0940206, 'created': 1697682027.268841, 'access': 1697682292.5433743, 'name': 'Sample_File.py', 'size': 1031, 'abspath': '/Users/YOU/Downloads/Sample_File.py', 'dirname': '/Users/YOU/Downloads', 'is_dir': False, 'is_file': True, 'is_link': False, 'exists': True, 'extension': 'py'}]
538538
```
539539
</details>
@@ -625,7 +625,7 @@ while True:
625625
from filesystem import console as fsconsole
626626
```
627627

628-
Console is a robust library designed to enable ANSI escape character sequences, which are used for generating colored terminal text and cursor positioning, to function seamlessly on MS Windows.
628+
Console is a robust library designed to enable ANSI escape character sequences, which are used for generating colored terminal text and cursor positioning.
629629
This library is a key addition to FileSystemPro as a third-party library, enhancing the toolkit for developers who require consistent terminal styling across different operating systems.
630630

631631
## Features
@@ -666,12 +666,13 @@ This library is a key addition to FileSystemPro as a third-party library, enhanc
666666

667667
## Sample Codes
668668

669+
> [!NOTE]
669670
> Please note that **GitHub (and PYPI) does not support colored text** in README files. This is due to the limitations of the markdown language used in GitHub (and PYPI) READMEs, which does not have built-in support for text color changes.
670671
671672
<details>
672673
<summary>Console: Printing a red foreground text message</summary>
673674

674-
The following example shows how to print some red foreground texts using Console
675+
The following example shows how to print some red foreground texts using **Console**
675676

676677
```py
677678
from filesystem import console as fsconsole
@@ -702,7 +703,7 @@ This is a new warn message</span>
702703
<details>
703704
<summary>Console: Printing a blue background text message</summary>
704705

705-
The following example shows how to print some blue background texts using Console
706+
The following example shows how to print some blue background texts using **Console**
706707

707708
```py
708709
from filesystem import console as fsconsole
@@ -711,7 +712,7 @@ from filesystem import console as fsconsole
711712
print(fsconsole.background.BLUE, 'This is a blue background message')
712713

713714
# This will print a no space text to your print message
714-
print(fsconsole.background.BLUE + 'This is another blue background warn message')
715+
print(fsconsole.background.BLUE + 'This is another blue background message')
715716

716717
# You can use f-string format to assign the color to your print
717718
print(f'{fsconsole.background.BLUE}This is a new blue background message{fsconsole.background.RESET}')
@@ -732,7 +733,7 @@ This is a new blue background message</span>
732733
<details>
733734
<summary>Console: Different foregrounds, backgrounds and styles</summary>
734735

735-
The following example shows how to print some texts with different backgrounds, foregrounds and styles using Console
736+
The following example shows how to print some texts with different backgrounds, foregrounds and styles using **Console**
736737

737738
```py
738739
# Prints a red foreground text
@@ -755,8 +756,8 @@ Output:
755756

756757
</details>
757758

758-
Remember, for the color changes to work, your console must support ANSI escape sequences, which are used to set the color. Not all consoles do, so if you’re not seeing the colors as expected, that could be why.
759+
Remember, for the color changes to work, your Terminal must support ANSI escape sequences, which are used to set the color. Not all Terminals do, so if you’re not seeing the colors as expected, that could be why.
759760

760761
---
761762

762-
Copyright © 2024 Bisneto Inc. All rights reserved.
763+
Copyright © 2023–2024 Bisneto Inc. All rights reserved.

0 commit comments

Comments
 (0)