DOC: update help text

Author: QingQiz

BmsToOsu/Option.cs

@@ -4,7 +4,7 @@ namespace BmsToOsu;
 
 public class Option
 {
-    [Option('i', "input", Required = true, HelpText = "folder containing bms charts")]
+    [Option('i', "input", Required = true, HelpText = "folder containing .bms/.bml/.bme/.bmx")]
     public string InputPath { get; set; } = null!;
 
     [Option('o', "output", Required = true, HelpText = "output folder/filename. e.g. 114514.osz")]
@@ -19,8 +19,7 @@ public class Option
     [Option("no-remove", Required = false, Default = false, HelpText = "whether to remove the output folder after zipping it to .osz")]
     public bool NoRemove { get; set; }
 
-    [Option("generate-mp3", Required = false, Default = false,
-        HelpText = "generate full song file from sample files of bms with hit sound disabled")]
+    [Option("generate-mp3", Required = false, Default = false, HelpText = "generate complete song file from samples of bms")]
     public bool GenerateMp3 { get; set; }
 
     [Option("ffmpeg", Required = false, Default = "", HelpText = "path of ffmpeg")]

BmsToOsu/Program.cs

@@ -169,8 +169,13 @@ void Proc(string path)
 {
     var helpText = HelpText.AutoBuild(result, h =>
     {
-        h.AutoHelp    = true;
-        h.AutoVersion = false;
+        h.AutoHelp                      = true;
+        h.AutoVersion                   = false;
+        h.AutoVersion                   = false;
+        h.AdditionalNewLineAfterOption  = false;
+        h.AddNewLineBetweenHelpSections = false;
+        h.Heading                       = "";
+        h.Copyright                     = "Copyright (c) 2022 QINGQIZ";
         return HelpText.DefaultParsingErrorsHandler(result, h);
     }, e => e);
     Console.WriteLine(helpText);

README.md

@@ -1,47 +1,46 @@
 # BMS to osu!mania 7k
 
-## TODO
-
-- [ ] FIX: Long Note behaves strangely when bpm changes (e.g. [destr0yer][d0]). Suspected to be a bug of osu
+> Convert bms files to osu beatmap files, including 7k and 7+1k
 
 ## Usage
 
-```shell
-.\BmsToOsu.exe --help
 ```
-
-### Example
-
-1. `.\BmsToOsu.exe -i /path/to/G2R2018 -o /path/to/osu!/Songs/G2R2018 --no-zip --no-remove` will convert G2R2018 to osu beatmaps and put it into the osu! Song folder 
-2. `.\BmsToOsu.exe -i /path/to/G2R2018 -o /G2R2018` will generate a .osz file named G2R2018.osz
-
-### Tested on the following beatmaps:
+  -i, --input       Required. folder containing .bms/.bml/.bme/.bmx
+  -o, --output      Required. output folder/filename. e.g. 114514.osz
+  --no-zip          (Default: false) whether to zip output folder to .osz
+  --no-copy         (Default: false) whether to copy sound/image/video files
+                    into the output folder
+  --no-remove       (Default: false) whether to remove the output folder after
+                    zipping it to .osz
+  --generate-mp3    (Default: false) generate complete song file from samples of bms 
+  --ffmpeg          (Default: ) path of ffmpeg
+  --help            Display this help screen.
+```
 
 <details>
 
 <summary>
-click to expand
+中文
 </summary>
 
-- normal beatmaps
-  - [Calamity Fortune][cf]
-  - [All Beatmaps of G2R2018][G2R2018]
-- bpm change
-  - [Aleph0][a0]
-- bga
-  - [Credits][credit]
-- long note
-  - [Destr0yer][d0]
-
-[cf]: http://yaruki0.sakura.ne.jp/event/ondanyugi5/impression.cgi?no=45
-[a0]: https://manbow.nothing.sh/event/event.cgi?action=More_def&num=498&event=110
-[credit]: https://manbow.nothing.sh/event/event.cgi?action=More_def&num=113&event=104
-[d0]: https://manbow.nothing.sh/event/event.cgi?action=More_def&num=353&event=123
-[G2R2018]: https://package.bms.ms/G2R2018%20CLIMAX%20-GO%20BACK%202%20YOUR%20ROOTS%202018%20CLIMAX-/
-
+```
+  -i, --input       Required. 输入文件夹，可以解析的文件包括 .bms/.bml/.bme/.bmx
+  -o, --output      Required. 输出文件夹/文件名
+  --no-zip          是否将输出文件夹压缩成 .osz，默认压缩
+  --no-copy         是否将 bms 谱面中的 声音/bga/图片 文件复制到输出文件夹，默认复制
+  --no-remove       是否在将输出文件夹压缩成 .osz 后删除输出文件夹，默认删除
+  --generate-mp3    是否从 bms 的采样中生成完整 mp3 文件，默认不生成（需要有 ffmpeg）
+  --ffmpeg          ffmpeg 可执行文件的路径，默认会在 PATH 中找
+  --help            展示帮助信息（但是英文）
+```
 </details>
 
 
+### Example
+
+1. `.\BmsToOsu.exe -i /path/to/G2R2018 -o /path/to/osu!/Songs/G2R2018 --no-zip --no-remove` will convert G2R2018 to osu beatmaps and put it into the osu! Song folder 
+2. `.\BmsToOsu.exe -i /path/to/G2R2018 -o /G2R2018` will generate a .osz file named G2R2018.osz
+
 ## Credits
 
 - [vysiondev](https://github.com/vysiondev)