Fix #2675

ICSharpCode.ILSpyCmd/ICSharpCode.ILSpyCmd.csproj

@@ -16,6 +16,7 @@
     <AssemblyName>ilspycmd</AssemblyName>
     <ToolCommandName>ilspycmd</ToolCommandName>
     <Description>Command-line decompiler using the ILSpy decompilation engine</Description>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageVersion>8.0.0.0-noversion</PackageVersion>
     <Copyright>Copyright 2011-$([System.DateTime]::Now.Year) AlphaSierraPapa</Copyright>
     <PackageProjectUrl>https://github.com/icsharpcode/ILSpy/</PackageProjectUrl>
@@ -27,6 +28,10 @@
     <Authors>ILSpy Team</Authors>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
+
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
     <TreatWarningsAsErrors>false</TreatWarningsAsErrors>
     <WarningsAsErrors>NU1605</WarningsAsErrors>

ICSharpCode.ILSpyCmd/IlspyCmdProgram.cs

@@ -27,6 +27,20 @@ namespace ICSharpCode.ILSpyCmd
 		ExtendedHelpText = @"
 Remarks:
   -o is valid with every option and required when using -p.
+
+Examples:
+    Decompile assembly to console out.
+        ilspycmd sample.dll
+
+    Decompile assembly to destination directory (single C# file).
+        ilspycmd -o c:\decompiled sample.dll
+
+    Decompile assembly to destination directory, create a project file, one source file per type.
+        ilspycmd -p -o c:\decompiled sample.dll
+
+    Decompile assembly to destination directory, create a project file, one source file per type, 
+    into nicely nested directories.
+        ilspycmd --nested-directories -p -o c:\decompiled sample.dll
 ")]
 	[HelpOption("-h|--help")]
 	[ProjectOptionRequiresOutputDirectoryValidation]

ICSharpCode.ILSpyCmd/README.md

@@ -1,22 +1,23 @@
-# ilspycmd
+# ilspycmd .NET 6.0 Tool 
+
+To install:
 
 ```
 dotnet tool install ilspycmd -g
 ```
 
-.NET Core 3.1 and .NET 6.0 Tool 
+Help output (`ilspycmd ---help`):
 
 ```
-ilspycmd -h
+ilspycmd: 8.0.0.7007
-ilspycmd: 7.2.0.0
+ICSharpCode.Decompiler: 8.0.0.7007
-ICSharpCode.Decompiler: 7.2.0.6768
 
 dotnet tool for decompiling .NET assemblies and generating portable PDBs
 
-Usage: ilspycmd [options] <Assembly file name>
+Usage: ilspycmd [options] <Assembly file name(s)>
 
 Arguments:
-  Assembly file name               The assembly that is being decompiled. This argument is mandatory.
+  Assembly file name(s)            The list of assemblies that is being decompiled. This argument is mandatory.
 
 Options:
   -v|--version                     Show version information.
@@ -36,7 +37,22 @@ Options:
   --no-dead-code                   Remove dead code.
   --no-dead-stores                 Remove dead stores.
   -d|--dump-package                Dump package assembiles into a folder. This requires the output directory option.
+  --nested-directories             Use nested directories for namespaces.
 
 Remarks:
   -o is valid with every option and required when using -p.
+
+Examples:
+    Decompile assembly to console out.
+        ilspycmd sample.dll
+
+    Decompile assembly to destination directory (single C# file).
+        ilspycmd -o c:\decompiled sample.dll
+
+    Decompile assembly to destination directory, create a project file, one source file per type.
+        ilspycmd -p -o c:\decompiled sample.dll
+
+    Decompile assembly to destination directory, create a project file, one source file per type,
+    into nicely nested directories.
+        ilspycmd --nested-directories -p -o c:\decompiled sample.dll
 ```