Skip to content
This repository has been archived by the owner on Jan 23, 2023. It is now read-only.

Update .NET Core DNX SDK acquisition instructions #870

Merged
merged 2 commits into from
Apr 29, 2015
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
10 changes: 6 additions & 4 deletions Documentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@ Documents Index

This repo includes several documents that explain both high-level and low-level concepts about the .NET runtime. These are very useful for contributors, to get context that can be very difficult to acquire from just reading code.

Get CoreCLR
===========
Get .NET Core
=============

- [Get .NET Core on Windows - NuGet](get-dotnetcore-windows-nuget.md)
- [Get .NET Core on Windows - .NET Version Manager](get-dotnetcore-windows-dnvm.md)
- [Get .NET Core DNX SDK on Windows](get-dotnetcore-dnx-windows.md)
- [Get .NET Core DNX SDK on OS X](get-dotnetcore-dnx-osx.md)
- [Get .NET Core DNX SDK on Linux](get-dotnetcore-dnx-linux.md)
- [Get .NET Core (Raw) on Windows](get-dotnetcore-windows.md)

Build CoreCLR from Source
=========================
Expand Down
127 changes: 127 additions & 0 deletions Documentation/get-dotnetcore-dnx-linux.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
Get the .NET Core DNX SDK on Linux
==================================

These instructions will lead you through acquiring the .NET Core DNX SDK via the [.NET Version Manager (DNVM)](https://github.com/aspnet/dnvm) and running a "Hello World" demo on Linux. The instructions use a particular set of paths. You'll need to adjust if you want to use a different set.

These instructions are for .NET Core console apps. If you want to try out ASP.NET 5 on top of .NET Core - which is a great idea - check out the [ASP.NET 5 instructions](https://github.com/aspnet/home).

.NET Core NuGet packages and the .NET Core DNX SDKs are available on the [ASP.NET 'vnext' myget feed](https://www.myget.org/F/aspnetvnext), which you can more easily view on [gallery](https://www.myget.org/gallery/aspnetvnext) for the feed.

You can also [build from source](linux-instructions.md).

Environment
===========

These instructions are written assuming the Ubuntu 14.04 LTS, since that's the distro the team uses. Pull Requests are welcome to address other environments as long as they don't break the ability to use Ubuntu 14.04 LTS.

Packages
--------

Install the following packages:

- libssl-dev
- libunwind8
- unzip

sudo apt-get install libunwind8 libssl-dev unzip

You also need a latest version of Mono, which is required for DNU. This is a temporary requirement.

sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF
echo "deb http://download.mono-project.com/repo/debian wheezy main" | sudo tee /etc/apt/sources.list.d/mono-xamarin.list
sudo apt-get update
sudo apt-get install mono-complete

Certificates
------------

You need to import trusted root certificates in order to restore NuGet packages. You can do that with the `mozroots` tool.

mozroots --import --sync
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't required anymore since Mono 3.12.0. Certificates are automatically imported when Mono is installed. I discovered recently that some systems like Linux Mint are configured in a way that this doesn't happen automatically, in those cases make sure the ca-certificates-mono package is installed.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The certs were to make curl work. Does your comment apply to that?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On my Ubuntu 15.04 system the certificates were also missing and I had to install them by hand.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mozroots has nothing to do with curl, it was (historically) used to import the Mozilla certificates into Mono's certificate store.


Installing DNVM
===============

You need DNVM to acquire a (or multiple) .NET Execution Environment (DNX) SDKs. DNVM is simply a script, which doesn't depend on .NET.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PowerShell seems a left over from the Windows version of the document. Suggest to replace PowerShell command with shell script.

curl -sSL https://raw.githubusercontent.com/aspnet/Home/dev/dnvminstall.sh | DNX_BRANCH=dev sh && source ~/.dnx/dnvm/dnvm.sh

You can see the currently installed DNX versions with `dnvm list`, which will display an empty set of installed runtimes.

dnvm list

Installing the .NET Core DNX SDK
================================

You first need to acquire the Mono DNX. It doesn't include Mono, but is needed to use the DNX tools on top of Mono. In particular, the DNU command is not yet supported on .NET Core, requiring us to use Mono for this purpose (until DNU runs on .NET Core). Mono is the default DNX, do you can acquire it via `dnvnm upgrade`.

dnvm upgrade -u

Next, acquire the .NET Core DNX SDK.

dnvm install latest -r coreclr -u

You can see the currently installed DNX versions with `dnvm list`.

dvnm list

```
Active Version Runtime Arch Location Alias
------ ------- ------- ---- -------- -----
* 1.0.0-beta5-11649 coreclr x64 ~/.dnx/runtimes
1.0.0-beta5-11649 mono ~/.dnx/runtimes default
```

Write your App
==============

You need a Hello World application to run. You can write your own, if you'd like. Here's a very simple one:

```csharp
using System;

public class Program
{
public static void Main (string[] args)
{
Console.WriteLine("Hello, Linux");
Console.WriteLine("Love from CoreCLR.");
}
}
```

Some people on the .NET Core team are partial to a demo console app on corefxlab repo which will print a picture for you. Download the [corefxlab demo](https://raw.githubusercontent.com/dotnet/corefxlab/master/demos/CoreClrConsoleApplications/HelloWorld/HelloWorld.cs) to the demo directory.

You need a `project.json` that matches your app. Use this one. It will work for both of the apps provided/referenced above. Save the project.json beside your app.

```
{
"version": "1.0.0-*",
"dependencies": {
},
"frameworks" : {
"dnx451" : { },
"dnxcore50" : {
"dependencies": {
"System.Console": "4.0.0-beta-*"
}
}
}
}
```

Run your App
============

You need to restore packages for your app, based on your project.json, with `dnu restore`. You will need to run this command under the Mono DNX. Make sure that you are using that one.

dnvm use 1.0.0-beta5-11649 -r mono
dnu restore

You can run your app with .NET Core, although make sure to switch to that DNX.

dnvm use 1.0.0-beta5-11649 -r coreclr
dnx . run

Hello, Linux
Love from CoreCLR.
99 changes: 99 additions & 0 deletions Documentation/get-dotnetcore-dnx-osx.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
Get the .NET Core DNX SDK on OS X
=================================

These instructions will lead you through acquiring the .NET Core DNX SDK via the [.NET Version Manager (DNVM)](https://github.com/aspnet/dnvm) and running a "Hello World" demo on OS X. The instructions use a particular set of paths. You'll need to adjust if you want to use a different set.

These instructions are for .NET Core console apps. If you want to try out ASP.NET 5 on top of .NET Core - which is a great idea - check out the [ASP.NET 5 instructions](https://github.com/aspnet/home).

.NET Core NuGet packages and the .NET Core DNX SDKs are available on the [ASP.NET 'vnext' myget feed](https://www.myget.org/F/aspnetvnext), which you can more easily view on [gallery](https://www.myget.org/gallery/aspnetvnext) for the feed.

You can also [build from source](osx-instructions.md).

Installing DNVM
===============

You need DNVM to acquire a (or multiple) .NET Execution Environment (DNX). DNVM is simply a script, which doesn't depend on .NET. On OS X the best way to get DNVM is to use [Homebrew](http://www.brew.sh). If you don't have Homebrew installed then follow the [Homebrew installation instructions](http://www.brew.sh). Once you have Homebrew then run the following commands:

brew tap aspnet/dnx
brew update
brew install dnvm

You will likely need to register the dnvm command:

source dnvm.sh

Installing the .NET Core DNX SDK
================================

You first need to acquire the Mono DNX. It includes a specfic version of Mono, and is needed to use the DNX tools that are not yet supported on .NET Core. Mono is the default DNX, so you can acquire it via `dnvnm upgrade`.

dnvm upgrade -u

Next, acquire the .NET Core DNX SDK.

dnvm install latest -r coreclr -u

You can see the currently installed DNX versions with `dnvm list`.

dvnm list

```
Active Version Runtime Arch Location Alias
------ ------- ------- ---- -------- -----
* 1.0.0-beta5-11649 coreclr x64 ~/.dnx/runtimes
1.0.0-beta5-11649 mono ~/.dnx/runtimes default
```

Write your App
==============

You need a Hello World application to run. You can write your own, if you'd like. Here's a very simple one:

```csharp
using System;

public class Program
{
public static void Main (string[] args)
{
Console.WriteLine("Hello, OS X");
Console.WriteLine("Love from CoreCLR.");
}
}
```

Some people on the .NET Core team are partial to a demo console app on corefxlab repo which will print a picture for you. Download the [corefxlab demo](https://raw.githubusercontent.com/dotnet/corefxlab/master/demos/CoreClrConsoleApplications/HelloWorld/HelloWorld.cs) to the demo directory.

You need a `project.json` that matches your app. Use this one. It will work for both of the apps provided/referenced above. Save the project.json beside your app.

```
{
"version": "1.0.0-*",
"dependencies": {
},
"frameworks" : {
"dnx451" : { },
"dnxcore50" : {
"dependencies": {
"System.Console": "4.0.0-beta-*"
}
}
}
}
```

Run your App
============

You need to restore packages for your app, based on your project.json, with `dnu restore`. You will need to run this command under the Mono DNX. Make sure that you are using that one.

dnvm use 1.0.0-beta5-11649 -r mono
dnu restore

You can run your app with .NET Core, although make sure to switch to that DNX.

dnvm use 1.0.0-beta5-11649 -r coreclr
dnx . run

Hello, OSX
Love from CoreCLR.
Original file line number Diff line number Diff line change
@@ -1,59 +1,59 @@
Get .NET Core on Windows with DNVM
==================================
Get the .NET Core DNX SDK on Windows
====================================

These instructions will lead you through acquiring .NET Core via the [.NET Version Manager (DNVM)](https://github.com/aspnet/dnvm) and running a "Hello World" demo on Windows. The instructions use a particular set of paths. You'll need to adjust if you want to use a different set.
These instructions will lead you through acquiring the .NET Core DNX SDK via the [.NET Version Manager (DNVM)](https://github.com/aspnet/dnvm) and running a "Hello World" demo on Windows. The instructions use a particular set of paths. You'll need to adjust if you want to use a different set.

These instructions are for .NET Core console apps. If you want to try out ASP.NET 5 on top of .NET Core - which is a great idea - check out the [ASP.NET 5 instructions](https://github.com/aspnet/home).

.NET Core is distributed as NuGet packages. You can acquire it via [NuGet restore](get-coreclr-windows-nuget.md) or the .NET Version Manager (these instructions). Alternatively, you can [build from source](windows-instructions.md).
.NET Core NuGet packages and the .NET Core DNX SDKs are available on the [ASP.NET 'vnext' myget feed](https://www.myget.org/F/aspnetvnext), which you can more easily view on [gallery](https://www.myget.org/gallery/aspnetvnext) for the feed.

You can see the [CoreCLR myget feed](https://www.myget.org/F/dotnet-core) @ the [dotnet-core gallery](https://www.myget.org/gallery/dotnet-core) page. These packages are not yet published to NuGet.org, but that will change soon.
You can also acquire .NET Core directly via [NuGet restore](get-coreclr-windows.md) or [build from source](windows-instructions.md).

Installing DNVM
===============

You need DNVM as a starting point. DNVM enables you to acquire a (or multiple) .NET Execution Environment (DNX). DNVM is simply a script, which doesn't depend on .NET. You can install it via a PowerShell command. You can find alternate DNVM install instructions at the [ASP.NET Home repo](https://github.com/aspnet/home).

@powershell -NoProfile -ExecutionPolicy unrestricted -Command "&{$Branch='dev';iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/aspnet/Home/dev/dnvminstall.ps1'))}"
C:\coreclr-demo> @powershell -NoProfile -ExecutionPolicy unrestricted -Command "&{$Branch='dev';iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/aspnet/Home/dev/dnvminstall.ps1'))}"

You must close your command-prompt and start a new one in order for the user-wide environment variables to take effect.

You can see the currently installed DNX versions with `dnvm list`, which will display an empty set of installed runtimes.

C:\coreclr-demo>dnvm list
C:\coreclr-demo> dnvm list

Installing a .NET Core DNX
==========================

It's easy to install the latest .NET Core-based DNX, using the ```dnvm install``` command.

C:\coreclr-demo>dnvm install -r coreclr latest
C:\coreclr-demo> dnvm install -r coreclr latest -u

This will install the 32-bit version of .NET Core. If you want the 64-bit version, you can specify processor architecture.

C:\coreclr-demo>dnvm install -r coreclr -arch x64 latest
C:\coreclr-demo> dnvm install -r coreclr -arch x64 latest -u

You can see the currently installed DNX versions with `dnvm list`.

C:\coreclr-demo>dnvm list

Active Version Runtime Architecture Location
------ ------- ------- ------------ --------
* 1.0.0-beta5-11596 coreclr x64 C:\Users\rlander\.dnx\runtimes
1.0.0-beta5-11596 coreclr x86 C:\Users\rlander\.dnx\runtimes
* 1.0.0-beta5-11649 coreclr x64 C:\Users\rlander\.dnx\runtimes
1.0.0-beta5-11649 coreclr x86 C:\Users\rlander\.dnx\runtimes

You can choose which of these DNXs you want to use with `dnvm use`, with similar arguments.

C:\coreclr-demo>dnvm use -r coreclr -arch x86 1.0.0-beta5-11596
Adding C:\Users\rlander\.dnx\runtimes\dnx-coreclr-win-x86.1.0.0-beta5-11596\bin
C:\coreclr-demo>dnvm use -r coreclr -arch x86 1.0.0-beta5-11649
Adding C:\Users\rlander\.dnx\runtimes\dnx-coreclr-win-x86.1.0.0-beta5-11649\bin
to process PATH

C:\coreclr-demo>dnvm list

Active Version Runtime Architecture Location
------ ------- ------- ------------ --------
1.0.0-beta5-11596 coreclr x64 C:\Users\rlander\.dnx\runtimes
* 1.0.0-beta5-11596 coreclr x86 C:\Users\rlander\.dnx\runtimes
1.0.0-beta5-11649 coreclr x64 C:\Users\rlander\.dnx\runtimes
* 1.0.0-beta5-11649 coreclr x86 C:\Users\rlander\.dnx\runtimes

Write your App
==============
Expand Down Expand Up @@ -98,10 +98,10 @@ Run your App

You need to restore packages for your app, based on your project.json, with `dnu restore`.

C:\coreclr-demo>dnu restore
C:\coreclr-demo> dnu restore

You can run your app with the DNX command.

C:\coreclr-demo>dnx . run
C:\coreclr-demo> dnx . run
Hello, Windows
Love from CoreCLR.
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
Get .NET Core on Windows with NuGet
===================================
Get .NET Core on Windows - Raw Experience
=========================================

These instructions will lead you through acquiring .NET Core via NuGet and running a "Hello World" demo on Windows. The instructions use a particular set of paths. You'll need to adjust if you want to use a different set.
These instructions will lead you through acquiring .NET Core directly via NuGet restore and running a "Hello World" demo on Windows. The instructions use a particular set of paths. You'll need to adjust if you want to use a different set.

.NET Core is distributed as NuGet packages. You can acquire it via NuGet restore (these instructions) or the [.NET Version Manager](get-coreclr-windows-dnvm.md). Alternatively, you can [build from source](windows-instructions.md).
These instructions are for .NET Core console apps. If you want to try out ASP.NET 5 on top of .NET Core - which is a great idea - check out the [ASP.NET 5 instructions](https://github.com/aspnet/home).

You can see the [CoreCLR myget feed](https://www.myget.org/F/dotnet-core) @ the [dotnet-core gallery](https://www.myget.org/gallery/dotnet-core) page. These packages are not yet published to NuGet.org, but that will change soon.
.NET Core NuGet packages are available on the [.NET Core myget feed](https://www.myget.org/F/dotnet-core), which you can more easily view on [gallery](https://www.myget.org/gallery/dotnet-core) for the feed.

The preferred approach to acquire .NET Core is via the [.NET Core DNX SDK](get-dotnetcore-dnx-windows.md). It's the easiest approach. Alternatively, you can [build from source](windows-instructions.md).

NuGet Restore Packages
======================
Expand Down Expand Up @@ -50,16 +52,18 @@ Write your App

You need a Hello World application to run. You can write your own, if you'd like. Here's a very simple one:

using System;

public class Program
{
public static void Main (string[] args)
{
Console.WriteLine("Hello, Windows");
Console.WriteLine("Love from CoreCLR.");
}
}
```csharp
using System;

public class Program
{
public static void Main (string[] args)
{
Console.WriteLine("Hello, Windows");
Console.WriteLine("Love from CoreCLR.");
}
}
```

Some people on the .NET Core team are partial to a demo console app on corefxlab repo which will print a picture for you. Download the [corefxlab demo](https://raw.githubusercontent.com/dotnet/corefxlab/master/demos/CoreClrConsoleApplications/HelloWorld/HelloWorld.cs) to ```C:\coreclr-demo```.

Expand All @@ -79,11 +83,11 @@ Prepare the demo

You need to copy the NuGet package assemblies over to the app folder. You need to run a few commands, including a little batch magic.

C:\coreclr-demo>for /f %k in ('dir /s /b packages\*.dll') do echo %k | findstr "\aspnetcore50" && copy /Y %k app
C:\coreclr-demo> for /f %k in ('dir /s /b packages\*.dll') do echo %k | findstr "\aspnetcore50" && copy /Y %k app

C:\coreclr-demo>copy packages\Microsoft.NETCore.Runtime.CoreCLR-x64.1.0.0-beta-22819\lib\any~win\x64\* app
C:\coreclr-demo> copy packages\Microsoft.NETCore.Runtime.CoreCLR-x64.1.0.0-beta-22819\lib\any~win\x64\* app

C:\coreclr-demo>copy packages\Microsoft.NETCore.Runtime.CoreCLR.ConsoleHost-x64.1.0.0-beta-22819\native\win\x64\CoreConsole.exe app\HelloWorld.exe
C:\coreclr-demo> copy packages\Microsoft.NETCore.Runtime.CoreCLR.ConsoleHost-x64.1.0.0-beta-22819\native\win\x64\CoreConsole.exe app\HelloWorld.exe

This last step might be a bit surprising, copying ```CoreConsole.exe``` to MyApp.exe, in this case ```HelloWorld.exe```. This is closedly related to compiling the app, in the instructions above, to MyApp.dll, in this case to ```HelloWorld.dll```.

Expand Down
Loading