Skip to content

remove outdated docs #1766

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 18, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 1 addition & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,45 +10,14 @@ Package | Version
---------------------------------| ------------------------------------------------------------------------------------------------------------------------------------------- | -----------------------------
`System.CommandLine` | [![Nuget](https://img.shields.io/nuget/v/System.CommandLine.svg)](https://nuget.org/packages/System.CommandLine) | Command line parser, model binding, invocation, shell completions
`System.CommandLine.DragonFruit` | [![Nuget](https://img.shields.io/nuget/v/System.CommandLine.DragonFruit.svg)](https://nuget.org/packages/System.CommandLine.DragonFruit) | Build command-line apps by convention with a strongly-typed `Main` method
`System.CommandLine.Rendering` | [![Nuget](https://img.shields.io/nuget/v/System.CommandLine.Rendering.svg)](https://nuget.org/packages/System.CommandLine.Rendering) | Structured terminal output rendering and ANSI support
`System.CommandLine.Hosting` | [![Nuget](https://img.shields.io/nuget/v/System.CommandLine.Hosting.svg)](https://nuget.org/packages/System.CommandLine.Hosting) | support for using System.CommandLine with [Microsoft.Extensions.Hosting](https://www.nuget.org/packages/Microsoft.Extensions.Hosting/)
`dotnet-suggest` | [![Nuget](https://img.shields.io/nuget/v/dotnet-suggest.svg)](https://nuget.org/packages/dotnet-suggest) | A command-line tool to provide shell completions for apps built using `System.CommandLine`.

Daily builds are available if you add this feed to your nuget.config: https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-libraries/nuget/v3/index.json.

## Documentation

### Breaking changes to the documentation in Beta 2

With the release of Beta 2, many of the examples in the documentation no longer work without changes.

Please see the [Beta 2 announcement](https://github.com/dotnet/command-line-api/issues/1537) for more details.

### Getting started

[Syntax Concepts and Parser](docs/Syntax-Concepts-and-Parser.md)

#### Features
* [Suggestions (tab completion)](docs/Features-overview.md#Suggestions)
* [Help](docs/Features-overview.md#Help)
* [Version option](docs/Features-overview.md#version-option)
* [Parse preview](docs/Features-overview.md#parse-preview)
* [Debugging](docs/Features-overview.md#debugging)
* [Response files](docs/Features-overview.md#Response-files)
* [Termination handling](docs/Process-termination-handling.md)

#### Your first app
* [System.CommandLine](docs/Your-first-app-with-System-CommandLine.md)
* [System.CommandLine.DragonFruit](docs/Your-first-app-with-System-CommandLine-DragonFruit.md)

#### How to...

* [Add a subcommand (or verb)](docs/How-To.md#Add-a-subcommand)
* [Add an alias to an option or command](docs/How-To.md#Add-an-alias-to-an-option-or-command)
* [Call a method](docs/How-To.md#Call-a-method)
* [Pass parameters to a method](docs/How-To.md#Pass-parameters-to-a-method)
* [Argument validation and binding](docs/How-To.md#Argument-validation-and-binding)
* [Middleware Pipeline](docs/How-To.md#Middleware-Pipeline)
The System.CommandLine documentation can now be found at [Microsoft Docs](https://docs.microsoft.com/en-us/dotnet/standard/commandline/).

## Code of Conduct

Expand Down
147 changes: 0 additions & 147 deletions docs/Features-overview.md

This file was deleted.

199 changes: 0 additions & 199 deletions docs/How-To.md

This file was deleted.

Loading