Merge pull request #10 from alexcu2718/docfix

docs: fix links and update improvements from refactor

Author: alexcu2718

IMPROVEMENTS.md

@@ -34,7 +34,7 @@ git checkout 27728cdadcd254a95bda48a3f10b6c8d892bea0d
 ## 2. Filesystem Optimisations
 
 - Implement a more efficient method to exclude ReiserFS - essentially a one-time assertion that isn't repeatedly called
-- Consider improved sorting algorithms in `src/printer.rs`
+- Consider improved sorting algorithms in `src/util/printer.rs`
 
 - Consider using `statx` on Linux, though this presents some challenges due to `statx` only recently becoming available on MUSL. However, `statx` only requests the attributes explicitly asked for, potentially offering speed benefits as well as additional metadata. This requires careful consideration. See the [Rust implementation](https://github.com/rust-lang/rust/blob/07bdbaedc63094281483c40a88a1a8f2f8ffadc5/library/std/src/sys/fs/unix.rs#L105) for reference.
 
@@ -79,6 +79,10 @@ Found 3 outliers among 100 measurements (3.00%)
 
 Implement extra functionality such as custom `.fdfignore` files. This shouldn't be particularly difficult to implement. Additional features to be added as requirements arise.
 
+Another one is the wrap any files from printing in quotes, so they can be passed to xargs (if they annoyingly contain spaces...)
+
+Printing additional file metadata on request (like ls)
+
 **Note**: Ideally implemented after the parallelisation restructure below is resolved.
 
 ## 5. Parallelisation Restructure
@@ -104,7 +108,7 @@ impl TLSRegex {
 
 ## 7. CIFS Filesystem Issue
 
-The `getdents` skip code (in `src/iter.rs` around line 243) encounters issues on certain exotic CIFS filesystems. This was observed on a friend's server setup but hasn't been reproducible since, and access to the original server is no longer available.
+The `getdents` skip code [in src/fs/iter.rs](./src/fs/iter.rs#L195) encounters issues on certain exotic CIFS filesystems. This was observed on a friend's server setup but hasn't been reproducible since, and access to the original server is no longer available.
 
 Reverting to the standard `getdents` "call until 0" paradigm resolved the issue and returned the expected results.
 

README.md

@@ -2,7 +2,9 @@
 
 [![Rust CI](https://github.com/alexcu2718/fdf/workflows/Rust/badge.svg)](https://github.com/alexcu2718/fdf/actions)
 
-fdf is a high-performance POSIX file finder written in Rust with extensive C FFI. It serves as a lightweight alternative to tools such as fd and find, with a focus on speed, efficiency, and cross-platform compatibility. Benchmarks demonstrate fdf running up to 2x faster than comparable tools, achieved through low-level optimisation, SIMD techniques, and direct kernel interfacing.
+fdf is a high-performance POSIX file finder written in Rust with extensive C FFI.
+
+It serves as a lightweight alternative to tools such as fd and find, with a focus on speed, efficiency, and cross-platform compatibility. Benchmarks demonstrate fdf running up to 2x faster than comparable tools, achieved through low-level optimisation, SIMD techniques, and direct kernel interfacing.
 
 PLEASE NOTE: This is due to undergo a rename before a 1.0
 
@@ -125,7 +127,7 @@ To avoid issues, use --same-file-system when traversing symlinks. Both fd and fi
 
 ### Key Optimisations
 
-- **getdents64: Optimised the Linux/Android-specific directory reading by significantly reducing the number of getdents system calls.  This approach enables single-pass reads for small directories and reduces getdents invocations by roughly 50% in testing. See the skip code(or follow link) [in src/iter.rs](./src/iter.rs#L195)**
+- **getdents64: Optimised the Linux/Android-specific directory reading by significantly reducing the number of getdents system calls.  This approach enables single-pass reads for small directories and reduces getdents invocations by roughly 50% in testing. See the skip code(or follow link) [in src/fs/iter.rs](./src/fs/iter.rs#L195)**
 
 - **find_char_in_word/find_last_char_in_word**: Locates the first/last occurrence of a byte in a 64-bit word using SWAR (SIMD within a register), implemented as a const function
 
@@ -135,7 +137,7 @@ To avoid issues, use --same-file-system when traversing symlinks. Both fd and fi
 
 The following function provides an elegant solution to avoid branch mispredictions/SIMD instructions during directory entry parsing (a performance-critical loop):
 
-Check source code for further explanation [in src/utils.rs](./src/utils.rs#L195)**
+Check source code for further explanation [in utils.rs](./src/util/utils.rs#L195)**
 
 ```rust
 // Computational complexity: O(1) - truly constant time
@@ -222,7 +224,7 @@ I additionally emailed the author of memchr and got some nice tips, great guy, s
 
 ### Feature Enhancements (Planned)
 
-More elaborate improvements discussed [at this link]( ./IMPROVEMENTS.md   )
+More elaborate improvements/fixes discussed [at this link]( ./IMPROVEMENTS.md   )
 
 **API cleanup, currently the CLI is the main focus but I'd like to fix that eventually!**