summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJan Kotas <jkotas@microsoft.com>2016-10-17 18:29:03 -0700
committerJan Kotas <jkotas@microsoft.com>2016-10-17 19:41:46 -0700
commit99937eea327509bef5bec333596d91daebd5abde (patch)
tree76ac4bb5f1d6dfc774628be1c944284a967b18f2 /Documentation
parent943b05e15ea0d8936b7ebd145391d7c82f26d3e7 (diff)
downloadcoreclr-99937eea327509bef5bec333596d91daebd5abde.tar.gz
coreclr-99937eea327509bef5bec333596d91daebd5abde.tar.bz2
coreclr-99937eea327509bef5bec333596d91daebd5abde.zip
Include project.json template in the instructions
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/workflow/UsingYourBuild.md76
1 files changed, 21 insertions, 55 deletions
diff --git a/Documentation/workflow/UsingYourBuild.md b/Documentation/workflow/UsingYourBuild.md
index c705c06c97..b1db49093c 100644
--- a/Documentation/workflow/UsingYourBuild.md
+++ b/Documentation/workflow/UsingYourBuild.md
@@ -16,7 +16,7 @@ standard 'dotnet' host that installs with .NET Core SDK.
The released version of 'dotnet' tool may not be compatible with the live CoreCLR repository. The following steps
assume use of unreleased version of 'dotnet' tool that is downloaded as part of the CoreCLR repository
-build at `Tools\dotnetcli`. [Add `Tools\dotnetcli` directory to your path](../building/windows-instructions.md#adding-to-the-default-path-variable)
+build at `<repo root>\Tools\dotnetcli`. [Add `Tools\dotnetcli` directory to your path](../building/windows-instructions.md#adding-to-the-default-path-variable)
and type:
* dotnet -?
@@ -50,66 +50,31 @@ and you will get name of the which looks something like this
```
This gets us the version number, in the above case it is 1.2.0-beta-24528-0. We will
-use this in the next step.
+use this in the next step.
### Step 3: Modify the Project.json for the App to refer to your Runtime.
-Now Modify the HelloWorld\project.json with the following modifications
-
-1. **Remove** (or comment out) the following line from the Microsoft.NETCore.App dependency
-This tells the build system that you don't want to use runtime and libraries that came with
-the dotnet.exe tool but to fetch the dependencies from the Nuget cache. If you don't do this
-the tools will ignore your request to make the app use an explicitly specified runtime.
-```
- "type": "platform",
-```
-2. Add the following 'runtimes' line at the top level. The runtime name includes the OS name and the architecture name
-you can find the appropriate name for your OS [here](https://github.com/dotnet/core-docs/blob/master/docs/core/rid-catalog.md).
-This tells the tools exactly which flavor of OS and processor architecture you are running on, so it can find the right
-Nuget package for the runtime.
-```
- "runtimes": { "win7-x64": {} }
-```
-3. Add the following line to the dependencies section. This is where you need the version number
-for your build of the runtime.
+Replace the HelloWorld\project.json with (project.json)[../../tests/src/Common/netcoreapp/project.json], and update
+`1.2.0-beta-XXXXX-X` version number in the dependencies section with the version number for your build of the runtime.
This is the line that tells the tools that you want YOUR version of the CoreCLR runtime.
```
"Microsoft.NETCore.Runtime.CoreCLR": "1.2.0-beta-24528-0"
```
-4. Change `netcoreapp1.0` to `netcoreapp1.1`. This tells the tools that you want to use the latest .NET Core Framework.
-
-5. Make sure you have all the commas you need when you add the lines to make it valid JSON.
-
-You should end up with something that looks something like this.
-
-```javascript
-{
- "version": "1.0.0-*",
- "buildOptions": {
- "debugType": "portable",
- "emitEntryPoint": true
- },
- "dependencies": {},
-
- "frameworks": {
- "netcoreapp1.1": {
- "dependencies": {
- "Microsoft.NETCore.App": {
- // REMOVED "type": "platform",
- "version": "1.0.0"
- },
- "Microsoft.NETCore.Runtime.CoreCLR": "1.2.0-beta-24528-0" // NEW, including comma before
- },
- "imports": "dnxcore50"
- }
- },
- "runtimes": { // NEW including comma before.
- "win7-x64": {}
- },
-}
-```
-
-### Step 4: Place your build directory on your Nuget Path
+
+The differences between the project.json generated by the tool and the replacement:
+
+- Removed Microsoft.NETCore.App platform dependency (`"type": "platform"`). This tells the build system that you don't want to
+use runtime and libraries that came with the dotnet.exe tool but to fetch the dependencies from the Nuget cache. If you don't do this
+the tools will ignore your request to make the app use an explicitly specified runtime.
+- Added the 'runtimes' line at the top level. The runtime name includes the OS name and the architecture name
+you can find the appropriate name for your OS [here](https://github.com/dotnet/core-docs/blob/master/docs/core/rid-catalog.md).
+This tells the tools exactly which flavor of OS and processor architecture you are running on, so it can find the right
+Nuget package for the runtime.
+- Changed netcoreapp1.0 to netcoreapp1.1. This tells the tools that you want to use the latest .NET Core Framework.
+- Expanded Microsoft.NETCore.App metapackage into explicit list of the .NET Core Framework packages because of there is no good published
+build of Microsoft.NETCore.App metapackage for netcoreapp1.1 yet.
+
+### Step 4: Place your build directory and beta .NET Core Framework feed on your Nuget Path
You can do this by creating a file named Nuget.Config in the 'HelloWorld' directory with the following XML
Obviously **you need to update path in the XML to be the path to output directory for your build**.
@@ -127,7 +92,8 @@ you have told the tools where to find your new package.
<add key="enabled" value="True" />
</packageRestore>
<packageSources>
- <add key="Local CoreCLR" value="C:\Users\User\Source\Repos\coreclr-vancem\bin\Product\Windows_NT.x64.Release\.nuget\pkg" />
+ <add key="Local CoreCLR" value="C:\Users\User\Source\Repos\coreclr-vancem\bin\Product\Windows_NT.x64.Release\.nuget\pkg" />
+ <add key="myget.org dotnet-core" value="https://dotnet.myget.org/F/dotnet-core/api/v3/index.json" />
</packageSources>
<activePackageSource>
<add key="All" value="(Aggregate source)" />