Stéphane Klein avatar Stéphane Klein committed cc91da3

Append README file

Comments (0)

Files changed (2)

+=============================================
+Convert NFD unicode filesystem to NFC unicode
+=============================================
+
+This tool can convert file system encoded in NFD mode to NFC mode.
+
+On Mac OS X, the filesystem encode file name in NFD unicode 
+(http://en.wikipedia.org/wiki/Unicode_normalization#Example).
+On GNU/Linux, by default the filesystem encode file name in NFC unicode
+but it can also contain file encoded in NFD mode.
+You can use this tool to convert NFD to NFC.
+
+Usage:
+  convert-nfd-unicode-filesystem-to-nfc-unicode <path>
+  convert-nfd-unicode-filesystem-to-nfc-unicode <url>
+  convert-nfd-unicode-filesystem-to-nfc-unicode -h | --help | --version
+
+Examples :
+
+Convert on local file system (use it on GNU/Linux, not on Mac OS X) :
+
+    $ convert-nfd-unicode-filesystem-to-nfc-unicode /home/username/myproject/
+
+You can use ssh url syntax to fix unicode on remote host :
+
+    $ convert-nfd-unicode-filesystem-to-nfc-unicode foobar@example.com:2000:/home/foobar/www/
+
+Home page : https://bitbucket.org/harobed/convert-nfd-unicode-filesystem-to-nfc-unicode

src/convertnfdunicodefilesystemtonfcunicode/__init__.py

 
 def main():
     arguments = docopt(
-"""Usage:
+"""This tool can convert file system encoded in NFD mode to NFC mode.
+
+On Mac OS X, the filesystem encode file name in NFD unicode 
+(http://en.wikipedia.org/wiki/Unicode_normalization#Example).
+On GNU/Linux, by default the filesystem encode file name in NFC unicode
+but it can also contain file encoded in NFD mode.
+You can use this tool to convert NFD to NFC.
+
+Usage:
   convert-nfd-unicode-filesystem-to-nfc-unicode <path>
   convert-nfd-unicode-filesystem-to-nfc-unicode <url>
   convert-nfd-unicode-filesystem-to-nfc-unicode -h | --help | --version
 
-You can use ssh url syntax to fix unicode on remote host, example :
+Examples :
+
+Convert on local file system (use it on GNU/Linux, not on Mac OS X) :
+
+    $ convert-nfd-unicode-filesystem-to-nfc-unicode /home/username/myproject/
+
+You can use ssh url syntax to fix unicode on remote host :
 
     $ convert-nfd-unicode-filesystem-to-nfc-unicode foobar@example.com:2000:/home/foobar/www/
 
+Home page : https://bitbucket.org/harobed/convert-nfd-unicode-filesystem-to-nfc-unicode
 """,
         version='0.1.0'
     )
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.