search

BYVoid / OpenCC

Conversion between Traditional and Simplified Chinese
https://opencc.byvoid.com/
Apache License 2.0
8.3k stars 974 forks source link

`opencc`'s `--config` help message is not helpful #672

Open brlin-tw opened 2 years ago

brlin-tw commented 2 years ago

Currently opencc help message mentions:

   -c <file>,  --config <file>
     Configuration file

which doesn't include the built-in config names for the user to specify(e.g. tw2sp), as this option is commonly used one would have to refer https://github.com/BYVoid/OpenCC#預設配置文件 or http://byvoid.github.io/OpenCC/1.0.6/index.html#autotoc_md10 to find the exact argument to type, which is not a good user experience.

Also, it is confusing whether one should specify tw2sp or tw2sp.json as the option's argument, an usage example would be appreciated.

Thanks!

Reginald-Yoeng-Lee commented 5 months ago

What's more, it seems like there is no explanation about the config json file at all. I can't find any documents indicating or demonstrating the meaning of any property in the json file.