修改 README

lc6464 · Feb 19, 2024 · 31838bc · 31838bc
1 parent 05d6276
commit 31838bc
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 24 deletions.
diff --git a/Base16384.Net.csproj b/Base16384.Net.csproj
@@ -4,7 +4,7 @@
 		<TargetFramework>net8.0</TargetFramework>
 		<ImplicitUsings>enable</ImplicitUsings>
 		<Nullable>enable</Nullable>
-		<Version>2.0.0.0</Version>
+		<Version>2.0.0.0-RC.1</Version>
 		<Platforms>x64</Platforms>
 	</PropertyGroup>
 	<ItemGroup>

diff --git a/Base16384.Net.sln b/Base16384.Net.sln
@@ -3,18 +3,18 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 17
 VisualStudioVersion = 17.2.32616.157
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Base16384.Net", "Base16384.Net.csproj", "{732DDDD3-B246-4DBB-8447-F7B1808F86BC}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Base16384.Net", "Base16384.Net.csproj", "{732DDDD3-B246-4DBB-8447-F7B1808F86BC}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
-		Debug|Any CPU = Debug|Any CPU
-		Release|Any CPU = Release|Any CPU
+		Debug|x64 = Debug|x64
+		Release|x64 = Release|x64
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
-		{732DDDD3-B246-4DBB-8447-F7B1808F86BC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{732DDDD3-B246-4DBB-8447-F7B1808F86BC}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{732DDDD3-B246-4DBB-8447-F7B1808F86BC}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{732DDDD3-B246-4DBB-8447-F7B1808F86BC}.Release|Any CPU.Build.0 = Release|Any CPU
+		{732DDDD3-B246-4DBB-8447-F7B1808F86BC}.Debug|x64.ActiveCfg = Debug|x64
+		{732DDDD3-B246-4DBB-8447-F7B1808F86BC}.Debug|x64.Build.0 = Debug|x64
+		{732DDDD3-B246-4DBB-8447-F7B1808F86BC}.Release|x64.ActiveCfg = Release|x64
+		{732DDDD3-B246-4DBB-8447-F7B1808F86BC}.Release|x64.Build.0 = Release|x64
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

diff --git a/Program.cs b/Program.cs
@@ -1,4 +1,4 @@
-// 新的解析方式：https://github.com/execute233/Base16384.Net
+// 新的解析方式：Base16384.Net.exe <"e" | "d"> <source | "-"> [out | "-"]
 /*
 错误代码：
 1. 无法解析命令行参数

diff --git a/README.md b/README.md
@@ -6,20 +6,30 @@
 此项目引用实现后的库，作为控制台应用程序供用户使用。
 
 ## 使用方法
-### Tree
 ```
-|-- Base16384.Net.exe
-|-- Base16384.Net.dll
-|-- Source
-	|-- xxx.jpg
-	|-- xxx.png
-|-- Encoded
-	|-- xxx.jpg.Encoded
-	|-- xxx.png.Encoded
+Base16384.Net <"e" | "d"> <source | "-"> [out | "-"]
 ```
-### Command
-```
-Base16384.Net.exe <e|d>
-```
-- e: Encode，将 Source 目录下的文件编码至 Result 目录下
-- d: Decode，将 Encoded 目录下的文件解码至 Result 目录下
+- 参数一：e 为编码；d 为解码
+- 参数二：源文件(夹)路径，输入 `-` 则表示从标准输入读取数据。
+- 参数三：输出文件(夹)路径，可选，其中输出到标准输出时无信息提示
+	- 缺省
+		- 输入为标准输入时，结果输出到标准输出
+		- 输入为文件时，结果写入 `源文件名.encoded` 或 `源文件名.decoded`
+		- 输入为文件夹时，结果写入到 `encoded` 或 `decoded` 文件夹内相应结构的文件内
+	- `-` 表示输出到标准输出，输入为文件夹时无效
+	- 其他
+		- 输入为文件时，输出到指定文件
+		- 输入为文件夹时，输出到指定文件夹
+- 示例
+	- 编码
+		- `Base16384.Net.exe e C:\Users\lc6464\Desktop\test.mp4 C:\Users\lc6464\Desktop\test.mp4.txt`
+		- `$PSVersionTable.OS | Base16384.Net e - /root/os.txt`
+		- `Base16384.Net e "/home/lc6464/hello world.jpg" - > hw.txt`
+	- 解码
+		- `Base16384.Net.exe d C:\Users\lc6464\Desktop\test.encoded C:\Users\lc6464\Desktop\test.py`
+		- `Base16384.Net d /root/os.txt -`
+		- `Base16384.Net d /root/filesEncoded /home/lc6464/rawFiles`
+	- 测试
+		- `Base16384.Net.exe e C:\Users\lc6464\Desktop\test.mp4 - | Base16384.Net.exe d - C:\Users\lc6464\Desktop\test.mp4`
+		- `$PSVersionTable.OS | Base16384.Net e - | Base16384.Net d -`
+- 调试：将环境变量 `Base16384_Net_Debug` 设为 `true` `1` 等值，可输出调试信息。特别注意，即使编解码到标准输出，也会输出异常信息！