Merge branch 'readme' into develop

Author: moh-hassan

CHANGELOG.md

@@ -1,8 +1,36 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+CommandLineParser project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.7.0] - 2019-12-31
+### Added
+- Add option groups feature by [@hadzhiyski](https://github.com/commandlineparser/commandline/pull/552) - When one or more options has group set, at least one of these properties should have set value (they behave as required).
+- Add a new overload method for AutoBuild to enable HelpText customization by [@moh-hassan]().
+- Improve spacing in HelpText by [@asherber](https://github.com/commandlineparser/commandline/pull/494) by adding a new option in the HelpText.
+- Add a new option "SkipDefault" in UnParserSettings by [@moh-hassan](https://github.com/commandlineparser/commandline/pull/550) to add the ability of skipping the options with a default value and fix [#541](https://github.com/commandlineparser/commandline/issues/541).
+- Generate a new symbolic nuget Package by [@moh-hassan](https://github.com/commandlineparser/commandline/pull/554) to Improve the debugging of Applications with the  NuGet package using [symbols experience](https://github.com/NuGet/Home/wiki/NuGet-Package-Debugging-&-Symbols-Improvements).
+- Add Support to [SourceLink](https://github.com/dotnet/sourcelink/blob/master/docs/README.md) in the nuget package  [@moh-hassan](https://github.com/commandlineparser/commandline/pull/554).
+
+### Changed
+- Remove the Exception when both CompanyAttribute and CopyRightAttribute are null in the Excuting assembly and set the copyright text to a default value.
+- Change default copyright to include current year instead of 1 by @moh-hassan.
+- Enabling c# 8 and Vs2019.
+
+### Fixed
+- Fix NullReferenceException when creating a default immutable instance by [@0xced](https://github.com/commandlineparser/commandline/pull/495).
+- Fix issue [#496](https://github.com/commandlineparser/commandline/issues/496) - Cryptic error message with immutable option class by[@moh-hassan](https://github.com/commandlineparser/commandline/pull/555).
+- Fix UnParserExtensions.FormatCommandLine by [@moh-hassan](https://github.com/commandlineparser/commandline/pull/550) to resolve:
+  -  Fix Quote for Options of type DatTime [#502](https://github.com/commandlineparser/commandline/issues/502) and [#528](https://github.com/commandlineparser/commandline/issues/258).
+  - Fix Quote for options of type TimeSpan and DateTimeOffset.
+  - Fix Nullable type [#305](https://github.com/commandlineparser/commandline/issues/305)
+
+- Fix nuget Licence in nuget package by [@moh-hassan](https://github.com/commandlineparser/commandline/pull/549) and fix issue  [#545](https://github.com/commandlineparser/commandline/issues/545).
+- Fix PackageIconUrl warning in nuget package by [@moh-hassan](https://github.com/commandlineparser/commandline/pull/551).
+- Fix immutable nullException, Improve exception message when immutable type can't be created
+- Fix Custom help for verbs issue[#529](https://github.com/commandlineparser/commandline/issues/529)
+- Fix --help switch throwing exception in F# [#366](https://github.com/commandlineparser/commandline/issues/366)
+by [@WallaceKelly](https://github.com/commandlineparser/commandline/pull/493)
 
 ## [2.6.0] - 2019-07-31
 ### Added
@@ -48,7 +76,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Add support to  NetStandard2.0 by [@ViktorHofer](https://github.com/commandlineparser/commandline/pull/307) 
 - Add strong name signing  [@ViktorHofer](https://github.com/commandlineparser/commandline/pull/307) 
--  Added AutoHelp and AutoVersion properties to control adding of implicit 'help' and 'version' options/verbs by [@Athari](https://github.com/commandlineparser/commandline/pull/256). 
+-  Added AutoBuild and AutoVersion properties to control adding of implicit 'help' and 'version' options/verbs by [@Athari](https://github.com/commandlineparser/commandline/pull/256). 
 - Added simpler C# Quick Start example at readme.md by [@lythix](https://github.com/commandlineparser/commandline/pull/274).
 - Add validate feature in Set parameter, and throw exception, and show usage,Issue #283 by[@e673](https://github.com/commandlineparser/commandline/pull/286).
 
@@ -92,5 +120,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [2.2.0] - 2018-01-07 
 
-## [1.9.71.2] - 2013-02-27
-The starting bascode version
+## [1.9.71.2] - 2013-02-27: The starting bascode version

README.md

@@ -1,7 +1,7 @@
 [![Build status](https://ci.appveyor.com/api/projects/status/p61dj8udxs2aocmo/branch/master?svg=true)](https://ci.appveyor.com/project/commandlineparser/commandline/branch/master)
 [![NuGet](https://img.shields.io/nuget/dt/commandlineparser.svg)](http://nuget.org/packages/commandlineparser)
-[![NuGet](https://img.shields.io/nuget/v/commandlineparser.svg)](http://nuget.org/packages/commandlineparser)
-[![NuGet](https://img.shields.io/nuget/vpre/commandlineparser.svg)](http://nuget.org/packages/commandlineparser)
+[![NuGet](https://img.shields.io/nuget/v/commandlineparser.svg)](https://www.nuget.org/packages/CommandLineParser/)
+[![NuGet](https://img.shields.io/nuget/vpre/commandlineparser.svg)](https://www.nuget.org/packages/CommandLineParser.FSharp/)
 [![Join the Gitter chat!](https://badges.gitter.im/gsscoder/commandline.svg)](https://gitter.im/gsscoder/commandline?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 # Command Line Parser Library for CLR and NetStandard
@@ -20,14 +20,19 @@ __This library provides _hassle free_ command line parsing with a constantly upd
 
 # At a glance:
 
-- Compatible with __.NET Framework 4.0+__, __Mono 2.1+ Profile__, and __.NET Core__
+- Compatible with __.NET Framework 4.0+__, __Mono 2.1+ Profile__, __.NET Standard__ and __.NET Core__
 - Doesn't depend on other packages (No dependencies beyond standard base libraries)
 - One line parsing using default singleton: `CommandLine.Parser.Default.ParseArguments(...)`.
 - Automatic or one line help screen generator: `HelpText.AutoBuild(...)`.
-- Supports `--help`, `--version`, `version` and `help [verb]` by default.
+- Supports `--help`, `--version`, `version` and `help [verb]` by default with customization.
 - Map to sequences (via `IEnumerable<T>` and similar) and scalar types, including Enums and `Nullable<T>`.
 - You can also map to every type with a constructor that accepts a string (like `System.Uri`).
 - Define [verb commands](https://github.com/commandlineparser/commandline/wiki/Verbs) similar to `git commit -a`.
+- Support HelpText localization.
+- Support ordering of options in HelpText.
+- Support [Mutually Exclusive Options](https://github.com/commandlineparser/commandline/wiki/Mutually-Exclusive-Options) and Options groups.
+- Support named and value options.
+- Support Asynchronous programming with async and await.
 - Unparsing support: `CommandLine.Parser.Default.FormatCommandLine<T>(T options)`.
 - CommandLineParser.FSharp package is F#-friendly with support for `option<'a>`, see [demo](https://github.com/commandlineparser/commandline/blob/master/demo/fsharp-demo.fsx).  _NOTE: This is a separate NuGet package._
 - Most of features applies with a [CoC](http://en.wikipedia.org/wiki/Convention_over_configuration) philosophy.
@@ -48,7 +53,7 @@ You can utilize the parser library in several ways:
 
 C# Quick Start:
 
-```csharp
+```cs
 using System;
 using CommandLine;
 
@@ -83,9 +88,13 @@ namespace QuickStart
 }
 ```
 
-C# Examples:
+## C# Examples:
+
+<details>
+  <summary>Click to expand!</summary>
+
+```cs
 
-```csharp
 class Options
 {
   [Option('r', "read", Required = true, HelpText = "Input files to be processed.")]
@@ -109,14 +118,31 @@ class Options
 static void Main(string[] args)
 {
   CommandLine.Parser.Default.ParseArguments<Options>(args)
-    .WithParsed<Options>(opts => RunOptionsAndReturnExitCode(opts))
-    .WithNotParsed<Options>((errs) => HandleParseError(errs));
+    .WithParsed(RunOptions)
+    .WithNotParsed(HandleParseError);
+}
+static void RunOptions(Options opts)
+{
+  //handle options
 }
+static void HandleParseError(IEnumerable<Error> errs)
+{
+  //handle errors
+}
+
 ```
 
-F# Examples:
+</details>
+
+Demo to show IEnumerable  options and other usage:  [Online Demo](https://dotnetfiddle.net/wrcAxr)
+
+## F# Examples:
+
+<details>
+  <summary>Click to expand!</summary>
 
 ```fsharp
+
 type options = {
   [<Option('r', "read", Required = true, HelpText = "Input files.")>] files : seq<string>;
   [<Option(HelpText = "Prints all messages to standard output.")>] verbose : bool;
@@ -130,10 +156,15 @@ let main argv =
   | :? Parsed<options> as parsed -> run parsed.Value
   | :? NotParsed<options> as notParsed -> fail notParsed.Errors
 ```
+</details>
+
+## VB.NET Example:
+
+<details>
+  <summary>Click to expand!</summary>
 
-VB.NET:
+```vb
 
-```VB.NET
 Class Options
 	<CommandLine.Option('r', "read", Required := true,
 	HelpText:="Input files to be processed.")>
@@ -159,14 +190,19 @@ Sub Main(ByVal args As String())
         .WithNotParsed(Function(errs As IEnumerable(Of [Error])) 1)
 End Sub
 ```
+</details>
 
-### For verbs:
+## For verbs:
 
 1. Create separate option classes for each verb.  An options base class is supported.  
 2. Call ParseArguments with all the verb attribute decorated options classes.
 3. Use MapResult to direct program flow to the verb that was parsed.
 
-C# example:
+### C# example:
+
+
+<details>
+  <summary>Click to expand!</summary>
 
 ```csharp
 [Verb("add", HelpText = "Add file contents to the index.")]
@@ -191,10 +227,15 @@ int Main(string[] args) {
 	  errs => 1);
 }
 ```
+</details>
+
+### VB.NET example:
 
-VB.NET example:
 
-```VB.NET
+<details>
+  <summary>Click to expand!</summary>
+
+```vb
 <CommandLine.Verb("add", HelpText:="Add file contents to the index.")>
 Public Class AddOptions
     'Normal options here
@@ -218,10 +259,14 @@ Function Main(ByVal args As String()) As Integer
           )
 End Function
 ```
+</details>
 
-F# Example:
+### F# Example:
 
-```fsharp
+<details>
+  <summary>Click to expand!</summary>
+
+```fs
 open CommandLine
 
 [<Verb("add", HelpText = "Add file contents to the index.")>]
@@ -248,6 +293,11 @@ let main args =
 	| :? CloneOptions as opts -> RunCloneAndReturnExitCode opts
   | :? CommandLine.NotParsed<obj> -> 1
 ```
+</details>
+
+# Release History
+
+See the [changelog](CHANGELOG.md)
 
 # Contributors
 First off, _Thank you!_  All contributions are welcome.  

src/CommandLine/CommandLine.csproj

@@ -22,6 +22,7 @@
 		<PackageIcon>CommandLine20.png</PackageIcon>
 		<PackageProjectUrl>https://github.com/commandlineparser/commandline</PackageProjectUrl>
 		<PackageTags>command line;commandline;argument;option;parser;parsing;library;syntax;shell</PackageTags>
+		<PackageReleaseNotes>https://github.com/commandlineparser/commandline/blob/master/CHANGELOG.md</PackageReleaseNotes>
 		<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
 		<LangVersion>8.0</LangVersion>
 		<IncludeSymbols>true</IncludeSymbols>
@@ -47,7 +48,7 @@
 		<PackageReference Include="FSharp.Core" Version="4.0.0.1" Condition="'$(BuildTarget)' == 'fsharp'" />
 	</ItemGroup>
 	<ItemGroup>
-		<None Include="$(SolutionDir)LICENSE.md" Pack="true" PackagePath=""/>
-		<None Include="$(SolutionDir)art\CommandLine20.png" Pack="true" PackagePath=""/>
+		<None Include="..\..\LICENSE.md" Pack="true" PackagePath=""/>
+		<None Include="..\..\art\CommandLine20.png" Pack="true" PackagePath=""/>
 	</ItemGroup>
 </Project>