Fix Sorting to be consistent across systems (local & Github actions

Author: ComputerDaddyGuy

README.md

@@ -7,7 +7,7 @@ A lightweight Java library for printing directory structures in a clean, tree-li
 - Limit displayed children (fixed value or dynamically)
 - Compact directory chains
 - Maximum depth
-- File sort
+- Sorting
 
 > [!CAUTION]
 > This lib was developed just for fun, and has not been thoroughly tested!  
@@ -227,28 +227,29 @@ max_depth/
 ```
 
 ## Sorting
-Files and directories can be sorted using a custom comparator (default is alphabetical order). Class `PrettyPrintOptions.Sorts` helps you by providing some basic comparators.
+Files and directories can be sorted using a custom comparator (default is alphabetical order).
+If the provided comparator considers two paths equal (i.e., returns `0`), an alphabetical comparator is applied as a tie-breaker to ensure consistent results across all systems.  
+
+The `PrettyPrintOptions.Sorts` class provides a set of basic, ready-to-use comparators.
 
 ```java
 // Example: Sorting.java
 var prettyPrinter = FileTreePrettyPrinter.builder()
-    .customizeOptions(options -> options.withFileSort(PrettyPrintOptions.Sorts.ALPHABETICAL_ORDER.reversed()))
+    .customizeOptions(options -> options.withFileSort(PrettyPrintOptions.Sorts.DIRECTORY_FIRST))
     .build();
 ```
 ```
-file_sort/
-├─ dir_C/
-│  ├─ file_C_3
-│  ├─ file_C_2
-│  └─ file_C_1
-├─ dir_B/
-│  ├─ file_B_3
-│  ├─ file_B_2
-│  └─ file_B_1
-└─ dir_A/
-   ├─ file_A_3
-   ├─ file_A_2
-   └─ file_A_1
+sorting/
+├─ c_dir/
+│  └─ c_file
+├─ d_dir/
+│  ├─ d_b_dir/
+│  │  └─ d_b_file
+│  └─ d_a_file
+├─ a_file
+├─ b_file
+├─ x_file
+└─ y_file
 ```
 
 # Changelog

pom.xml

@@ -5,7 +5,7 @@
 
 	<groupId>io.github.computerdaddyguy</groupId>
 	<artifactId>jfiletreeprettyprinter</artifactId>
-	<version>0.0.2</version>
+	<version>0.0.2-SNAPSHOT</version>
 
 	<packaging>jar</packaging>
 	<name>JFileTreePrettyPrinter</name>

src/example/java/io/github/computerdaddyguy/jfiletreeprettyprinter/example/Sorting.java

@@ -7,9 +7,9 @@ public class Sorting {
 
 	public static void main(String[] args) {
 		var prettyPrinter = FileTreePrettyPrinter.builder()
-			.customizeOptions(options -> options.withFileSort(PrettyPrintOptions.Sorts.ALPHABETICAL_ORDER.reversed()))
+			.customizeOptions(options -> options.withFileSort(PrettyPrintOptions.Sorts.BY_FILE_SIZE))
 			.build();
-		var tree = prettyPrinter.prettyPrint("src/example/resources/file_sort");
+		var tree = prettyPrinter.prettyPrint("src/example/resources/sorting");
 		System.out.println(tree);
 	}
 

src/example/resources/file_sort/dir_A/file_A_2

@@ -0,0 +1 @@
+123456