Update documentation (#3549)
* Updating README.md files as well as man pages This aligns with the latest changes in the official documentation. It also aligns dotnet test readme.md to official docs and introduces a new doc in the "Documentation" directory that deals with dotnet test protocols.
This commit is contained in:
parent
18c8a2724a
commit
4da4f95e21
16 changed files with 971 additions and 404 deletions
|
@ -1,38 +1,81 @@
|
|||
.\" Automatically generated by Pandoc 1.15.1
|
||||
.\"
|
||||
.hy
|
||||
.TH "dotnet-new" "1" "January 2016" "" ""
|
||||
.SH NAME
|
||||
.TH "DOTNET\-NEW" "1" "June 2016" "" ""
|
||||
.SS NAME
|
||||
.PP
|
||||
dotnet\-new \-\- Create a new sample .NET Core project
|
||||
.SH SYNOPSIS
|
||||
.SS SYNOPSIS
|
||||
.PP
|
||||
dotnet new
|
||||
.SH DESCRIPTION
|
||||
dotnet new [\-\-type] [\-\-lang]
|
||||
.SS DESCRIPTION
|
||||
.PP
|
||||
The new command provides a convenient way to initalize a valid .NET Core
|
||||
project and sample source code to try out the CLI toolset.
|
||||
The \f[C]dotnet\ new\f[] command provides a convenient way to initialize
|
||||
a valid .NET Core project and sample source code to try out the Command
|
||||
Line Interface (CLI) toolset.
|
||||
.PP
|
||||
This command is invoked in the context of a directory.
|
||||
When invoked, the command will result in two main artifacts being
|
||||
dropped to the directory:
|
||||
.IP "1." 3
|
||||
A sample "Hello World" program that exists in \f[C]Program.cs\f[] file.
|
||||
A \f[C]Program.cs\f[] (or \f[C]Program.fs\f[]) file that contains a
|
||||
sample "Hello World" program.
|
||||
.IP "2." 3
|
||||
A valid \f[C]project.json\f[] file
|
||||
A valid \f[C]project.json\f[] file.
|
||||
.PP
|
||||
After this, the project is ready to be compiled and/or edited further.
|
||||
.SH EXAMPLES
|
||||
.SS Options
|
||||
.PP
|
||||
\f[C]\-l\f[], \f[C]\-\-lang\ [C#|F#]\f[]
|
||||
.PP
|
||||
Language of the project.
|
||||
Defaults to \f[C]C#\f[].
|
||||
\f[C]csharp\f[] (\f[C]fsharp\f[]) or \f[C]cs\f[] (\f[C]fs\f[]) are also
|
||||
valid options.
|
||||
.PP
|
||||
\f[C]\-t\f[], \f[C]\-\-type\f[]
|
||||
.PP
|
||||
Type of the project.
|
||||
Valid values for C# are:
|
||||
.IP \[bu] 2
|
||||
\f[C]console\f[]
|
||||
.IP \[bu] 2
|
||||
\f[C]web\f[]
|
||||
.IP \[bu] 2
|
||||
\f[C]lib\f[]
|
||||
.IP \[bu] 2
|
||||
\f[C]xunittest\f[]
|
||||
.PP
|
||||
Valid values for F# are:
|
||||
.IP \[bu] 2
|
||||
\f[C]console\f[]
|
||||
.SS EXAMPLES
|
||||
.PP
|
||||
\f[C]dotnet\ new\f[]
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
Drops\ a\ sample\ in\ the\ current\ directory.
|
||||
Drops\ a\ sample\ C##\ project\ in\ the\ current\ directory.
|
||||
\f[]
|
||||
.fi
|
||||
.PP
|
||||
\f[C]dotnet\ new\ \-\-lang\ f##\f[]
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
Drops\ a\ sample\ F##\ project\ in\ the\ current\ directory.
|
||||
\f[]
|
||||
.fi
|
||||
.PP
|
||||
\f[C]dotnet\ new\ \-\-lang\ c##\f[]
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
Drops\ a\ sample\ C##\ project\ in\ the\ current\ directory.
|
||||
\f[]
|
||||
.fi
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
dotnet\-run(1)
|
||||
.SH AUTHORS
|
||||
Zlatko Knezevic zlakne\@microsoft.com.
|
||||
Microsoft Corporation dotnetclifeedback\@microsoft.com.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue