mirrors/dotnet-installer
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Merge pull request #380 from LeeCampbell/patch-1

Browse source 
Update formatting on Publish/Readme.md
This commit is contained in:
Zlatko Knezevic 2015-12-04 06:18:03 -08:00
commit f9a553c93f
1 changed files with 42 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

65
src/Microsoft.DotNet.Tools.Publish/README.md
View file

@ -3,53 +3,72 @@ dotnet-publish
**NAME**
dotnet-publish -- packs the application and all of its dependencies into a folder getting it ready for publishing
`dotnet-publish`
> packs the application and all of its dependencies into a folder getting it ready for publishing
**SYNOPSIS**
dotnet-publish [options] [project]
`dotnet-publish [options] [project]`
**DESCRIPTION**
dotnet-publish will compile the application, read through its dependencies specified in project.json and publish the resulting set of files to a directory. This directory contains the assemblies, the runtime as well as the runnable version of the application. This directory can then be moved to a different machine and the application will be able to be ran regardless of existence of any other runtime.
dotnet-publish needs access to project.json to work. If it is not specified on invocation via [project], project.json in the current directory will be the default. If no project.json can be found, dotnet-publish will error out.
`dotnet-publish` will compile the application, read through its dependencies specified in _project.json_ and publish the resulting set of files to a directory.
This directory contains the assemblies, the runtime as well as the runnable version of the application.
This directory can then be moved to a different machine and the application will be able to be ran regardless of existence of any other runtime.
The command also requires information on the targeted framework and runtime, both of which can be specified on the command line. If the runtime is not specified, the command will default to the runtime for the current operating system. If the framework is not specified, the command will read the information from the project.json file. In case of no valid framework found, the command will error out. In case of multiple valid frameworks found, the command will publish for all valid frameworks.
`dotnet-publish` needs access to _project.json_ to work.
If it is not specified on invocation via [project], _project.json_ in the current directory will be the default.
If no _project.json_ can be found, `dotnet-publish` will error out.
The command also requires information on the targeted framework and runtime, both of which can be specified on the command line.
If the runtime is not specified, the command will default to the runtime for the current operating system.
If the framework is not specified, the command will read the information from the _project.json_ file.
In case of no valid framework found, the command will error out.
In case of multiple valid frameworks found, the command will publish for all valid frameworks.
* ubuntu
**Options**
-f, --framework [FID]
Publish the application for a given framework identifier (FID). If not specified, FID is read from project.json
`-f`, `--framework` [FID]
Publish the application for a given framework identifier (FID).
If not specified, FID is read from _project.json_.
`-r`, `--runtime` [RID]
Publish the application for a given runtime.
Supported values for runtimes at this time are:
-r, --runtime [RID]
Publish the application for a given runtime. Supported values for runtimes at this time are:
* ubuntu.14.04-x64
* win7-x64
* osx.10.10-x64
-o, --output
Specify the path where to place the directory. If not specified, will default to ./bin/[configuration]/[framework]/[runtime]/
`-o`, `--output`
-c, --configuration [Debug|Release]
Configuration to use when publishing. If not specified, will default to "Debug".
Specify the path where to place the directory.
If not specified, will default to _./bin/[configuration]/[framework]/[runtime]/_
`-c`, `--configuration [Debug|Release]`
Configuration to use when publishing.
If not specified, will default to "Debug".
**EXAMPLES**
dotnet-publish
Publish the current application using the project.json framework and runtime for the current operating system.
dotnet-publish ~/projects/app1/project.json
Publish the application using the specified project.json; also use framework specified withing and runtime for the current operating system.
`dotnet-publish`
>Publish the current application using the _project.json_ framework and runtime for the current operating system.
`dotnet-publish ~/projects/app1/project.json`
>Publish the application using the specified _project.json_; also use framework specified withing and runtime for the current operating system.
dotnet-publish --framework dnxcore50
Publish the current application using the dnxcore50 framework and runtime for the current operating system.
`dotnet-publish --framework dnxcore50`
>Publish the current application using the `dnxcore50` framework and runtime for the current operating system.
dotnet-publish --framework dnxcore50 --runtime osx.10.10-x64
Publish the current application using the dnxcore50 framework and runtime for OS X 10.10
`dotnet-publish --framework dnxcore50 --runtime osx.10.10-x64`
>Publish the current application using the `dnxcore50` framework and runtime for `OS X 10.10`
**SEE ALSO**
dotnet-restore
`dotnet-restore`