Skip to content

Commit c5e61d7

Browse files
committed
Update README.md
1 parent ef567bd commit c5e61d7

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
# fnorm - FixNormalization
22
Fix Unicode normalization in filenames.
33

4+
> [!IMPORTANT]
5+
> This software is in development. It may contains unknown or potential bugs and unexpected behaviors. If you find or encounter those, Open an issue at this repository and describe it.
6+
47
## Introduction
5-
fnorm(EEF-NOHRM) is a simple desktop application to fix Unicode normalization in filenames. From Form D to Form C, and vice versa.
8+
**fnorm**(EEF-NOHRM) is a simple desktop application to fix Unicode normalization in filenames. From Form D to Form C, and vice versa.
69

7-
It is especially useful when you met nasty messed filename including characters which can be decomposed after moving files from macOS (or Darwin based-OSes) to Windows or Linux.
10+
It is especially useful when you met <ins>a nasty messed filename</ins> including characters which can be decomposed after moving files from macOS (or Darwin based-OSes) to Windows or Linux.
811
(e.g. 한글 -> ᄒ​ᅡ​ᆫᄀ​ᅳ​ᆯ). In particular in Hangul, it has been considered really notorious problem among people who need to communicate files with different OSes.
912

1013
This problem is derived from discrepancy in processing Unicode characters between Darwin (**macOS**, iPadOS, iOS, tvOS, watchOS, visionOS) and others, because HFS+, a filesystem that once Apple had been applied in their OSes, uses Normalization D to save filenames in UTF-16.
@@ -19,15 +22,22 @@ That's why I made this humble tool.
1922
## Installation
2023

2124
```fnorm``` supports Windows, and Linux with x64 and ARM64 architectures. macOS will be supported soon.
22-
23-
### Requirements
24-
* [.NET 9](https://dotnet.microsoft.com/en-us/download/dotnet/9.0) Runtime
25-
2625
You can install ```fnorm``` in various ways.
2726

2827
Visit [the release page](https://github.com/Capella87/FixNormalization/releases) and download the latest version of fnorm. See assets.
2928
Or you can use a package manager shown below.
3029

30+
### Requirements
31+
* **[.NET 9](https://dotnet.microsoft.com/en-us/download/dotnet/9.0)** Runtime [Mandatory]
32+
33+
Although the program is automatically setting console output to UTF-8, you may have to enable Windows option, '**Beta: Use Unicode UTF-8 for worldwide language support**' (Beta: 세계 언어 지원을 위해 Unicode UTF-8 사용) in Region settings to see Unicode characters correctly in Windows console environment.
34+
That's because Windows still uses MBCS(Multi-Byte Character Set) as a default encoding in system for legacy, (e.g. CP949 for Korean) and it may causes problem in processing and showing latest Unicode characters right.
35+
36+
But this option can be problematic in some programs which forces or are sticked to specific encoding. (e.g. MapleStory, Fallout: New Vegas)
37+
You can also make a workaround by type ```chcp 65001``` to set UTF-8 encoding in the console section prior to executing this program.
38+
39+
I recommend to run the program in Windows Terminal with PowerShell 7.
40+
3141
### Scoop
3242

3343
You can easily install fnorm in Windows with [Scoop](https://scoop.sh) and my bucket, [capella-bucket](https://github.com/Capella87/capella-bucket).
@@ -72,6 +82,10 @@ Convert filenames to follow Normalization Form C. If you don't specify ```--form
7282

7383
Convert filenames to follow Normalization Form D. In general cases you don't have to care about this option.
7484

85+
### ```--recursive``` or ```-r```
86+
87+
Enable recursive search in directories.
88+
7589
### Example
7690

7791
```shell
@@ -82,3 +96,5 @@ fnorm fix C:\\Users\user\Desktop C:\\Users\user\Documents --form nfc
8296
This software is distributed under MIT License. I don't have any responsibility for any damage caused by using this software.
8397

8498
---
99+
100+
Copyright (c) 2024-2025 **Capella87**. Distributed under MIT License.

0 commit comments

Comments
 (0)