Skip to content

Commit a2de4ff

Browse files
committed
Update readme from KRE to DNX
1 parent 8c2262d commit a2de4ff

File tree

1 file changed

+42
-24
lines changed

1 file changed

+42
-24
lines changed

README.md

Lines changed: 42 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ASP.NET 5 Home
2-
Latest dev version: [![dev version](http://img.shields.io/myget/aspnetvnext/v/kre-clr-win-x86.svg?style=flat)](https://www.myget.org/gallery/aspnetvnext)<br>
2+
Latest dev version: [![dev version](http://img.shields.io/myget/aspnetvnext/v/dnx-clr-win-x86.svg?style=flat)](https://www.myget.org/gallery/aspnetvnext)<br>
33
Latest master version: [![master version](http://img.shields.io/myget/aspnetmaster/v/kre-clr-win-x86.svg?style=flat)](https://www.myget.org/gallery/aspnetmaster)
44

55
The Home repository is the starting point for people to learn about ASP.NET 5. This repo contains samples and [documentation](https://github.com/aspnet/Home/wiki) to help folks get started and learn more about what's coming in ASP.NET 5.
@@ -8,6 +8,7 @@ ASP.NET 5 is being actively developed by the ASP.NET team assigned to the Micros
88

99
The samples provided in this repo are designed to show some of the features of the new framework and to provide a starting point for further exploration. All the component packages are available on NuGet. To try out the latest bits under development switch to the dev branch of the Home repo and use the dev feed in NuGet.config (https://www.myget.org/F/aspnetvnext).
1010

11+
1112
## Contents
1213

1314
* [Minimum Requirements](#minimum-requirements)
@@ -29,38 +30,41 @@ These are the current minimum requirements for the latest preview release. They
2930
* Mono 3.4.1 or later (Note: On OS X use the Homebrew formula specified below to install the required version of Mono)
3031
* bash or zsh and curl
3132

33+
3234
## Getting Started
3335

3436
The easiest way to get started with ASP.NET 5 is to try out the latest preview of Visual Studio 2015 Preview. You can find installation instructions and getting started documentation at http://www.asp.net/vnext.
3537

3638
That said, you can also try out ASP.NET 5 with just a command-prompt and a text editor. The following instructions will walk you through getting your dev environment setup.
3739

38-
### Install the K Version Manager (KVM)
40+
### Install the .NET Version Manager (DNVM)
3941

40-
The first thing we need to do is setup the tools required to build and run an application. We will start out by getting the [K Version Manager (KVM)](https://github.com/aspnet/Home/wiki/version-manager). We use the K Version Manager to install different versions of the ASP.NET 5 runtime and switch between them.
42+
Note: DNVM was formerly called KVM.
43+
44+
The first thing we need to do is setup the tools required to build and run an application. We will start out by getting the [.NET Version Manager (DNVM)](https://github.com/aspnet/Home/wiki/version-manager). We use the .NET Version Manager to install different versions of the .NET Execution Environment (DNX) (used by the ASP.NET 5 runtime) and switch between them.
4145

4246
#### Windows
43-
To install KVM on Windows run the following command, which will download and run a script that installs KVM for the current user (requires admin privileges for Powershell).
47+
To install DNVM on Windows run the following command, which will download and run a script that installs DNVM for the current user (requires admin privileges for Powershell).
4448

45-
##### Stable(ish)
46-
This will use the currently released version of `kvm` (from the `release` branch of this repo).
49+
##### Stable(ish) (KVM)
50+
This will use the currently released version of `kvm` (from the `master` branch of this repo). (KVM was renamed to DNVM after the current public release.)
4751

4852
```
4953
@powershell -NoProfile -ExecutionPolicy unrestricted -Command "iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/aspnet/Home/master/kvminstall.ps1'))"
50-
5154
```
5255

53-
##### Optimistic
54-
If you want to run on the bleeding edge and install the latest development version of KVM, run the following command:
56+
##### Optimistic (DNVM)
57+
If you want to run on the bleeding edge and install the latest development version of DNVM (formerly called KVM), run the following command:
5558

5659
```
57-
@powershell -NoProfile -ExecutionPolicy unrestricted -Command "&{$Branch='dev';iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/aspnet/Home/master/kvminstall.ps1'))}"
60+
@powershell -NoProfile -ExecutionPolicy unrestricted -Command "&{$Branch='dev';iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/aspnet/Home/dev/dnvminstall.ps1'))}"
5861
```
5962

60-
After the script has run open a new command prompt to start using KVM.
63+
After the script has run open a new command prompt to start using DNVM.
6164

6265
#### OS X:
6366

67+
##### Stable(ish) (KVM)
6468
To install KVM and the correct version of Mono on OS X using [Homebrew](http://brew.sh) follow the following steps:
6569

6670
* Install [Homebrew](http://brew.sh) if it is not already installed.
@@ -70,25 +74,39 @@ To install KVM and the correct version of Mono on OS X using [Homebrew](http://b
7074

7175
#### Linux:
7276

77+
Note that on Linux you need to also install [Mono](http://mono-project.com) 3.4.1 or later.
78+
79+
##### Stable(ish) (KVM)
7380
Installing KVM requires `curl`. Do verify if that is installed on the machine. Next install KVM on Linux run the following command:
7481

7582
```
7683
curl -sSL https://raw.githubusercontent.com/aspnet/Home/master/kvminstall.sh | sh && source ~/.k/kvm/kvm.sh
7784
```
7885

79-
If you want to run on the bleeding edge and install the latest development version of KVM, use this command:
86+
##### Optimistic (DNVM)
87+
If you want to run on the bleeding edge and install the latest development version of DNVM (formerly called KVM), run the following command:
8088

8189
```
82-
curl -sSL https://raw.githubusercontent.com/aspnet/Home/master/kvminstall.sh | KVM_BRANCH=dev sh && source ~/.k/kvm/kvm.sh
90+
curl -sSL https://raw.githubusercontent.com/aspnet/Home/dev/dnvminstall.sh | DNX_BRANCH=dev sh && source ~/.dnx/dnvm/dnvm.sh
8391
```
8492

85-
Note that on Linux you need to also install [Mono](http://mono-project.com) 3.4.1 or later.
8693

87-
### Install the K Runtime Environment (KRE)
94+
### Install the .NET Execution Environment (DNX)
8895

89-
Now that you have KVM setup you can install the latest version of the runtime by running the following command: ```kvm upgrade```
96+
##### Stable(ish) (KRE)
97+
98+
Now that you have KVM set up you can install the latest version of the runtime by running the following command: ```kvm upgrade```
99+
100+
This command will download the specified version of the KRE, and put it on your user profile ready to use. You are now ready to start using ASP.NET 5 with the KRE!
101+
102+
##### Optimistic (DNX)
103+
104+
Note: DNX was formerly called KRE.
105+
106+
Now that you have DNVM set up you can install the latest version of the runtime by running the following command: ```dnvm upgrade```
90107

91-
This command will download the specified version of the K Runtime Environment (KRE), and put it on your user profile ready to use. You are now ready to start using ASP.NET 5!
108+
This command will download the specified version of the DNX, and put it on your user profile ready to use. You are now ready to start using ASP.NET 5 with the DNX!
109+
92110

93111
## Samples
94112

@@ -105,19 +123,19 @@ The samples in this repo are basic starting points for you to experiment with.
105123
2. Change directory to the folder of the sample you want to run
106124
3. Run ```kpm restore``` to restore the packages required by that sample.
107125
4. You should see a bunch of output as all the dependencies of the app are downloaded from MyGet.
108-
5. Run the sample using the appropriate K command:
109-
- For the console app run ```k run```.
110-
- For the web apps run ```k web``` on Windows or ```k kestrel``` on Mono.
126+
5. Run the sample using the appropriate `dnx` command:
127+
- For the console app run ```dnx . run```.
128+
- For the web apps run ```dnx . web``` on Windows or ```dnx . kestrel``` on Mono.
111129
6. You should see the output of the console app or a message that says the site is now started.
112130
7. You can navigate to the web apps in a browser by going to "http://localhost:5001" or "http://localhost:5004" if running on Mono.
113131

114132
### Switching to Core CLR
115133

116-
By default when running ASP.NET 5 applications on the Windows platform you are running on the full .NET Framework. You can switch to use the new Cloud Optimized runtime, or Core CLR, using the KVM command.
134+
By default when running ASP.NET 5 applications on the Windows platform you are running on the full .NET Framework. You can switch to use the new Cloud Optimized runtime, or Core CLR, using the DNVM command.
117135

118-
1. Run ```kvm upgrade -runtime CoreCLR``` This command gets the latest Core CLR version of the k runtime and sets it as your default. The `-runtime CoreCLR` switch tells it to use Core CLR. You can use `-r CLR` to target desktop again.
119-
2. Run ```k web``` to run on WebListener.
120-
3. The first line of your output should say "Loaded Module: klr.core45.dll" instead of "Loaded Module: klr.net45.dll"
136+
1. Run ```dnvm upgrade -runtime CoreCLR``` This command gets the latest Core CLR version of the DNX and sets it as your default. The `-runtime CoreCLR` switch tells it to use Core CLR. You can use `-r CLR` to target desktop again.
137+
2. Run ```dnx . web``` to run on WebListener.
138+
3. The first line of your output should say "Loaded Module: dnx.core45.dll" instead of "Loaded Module: dnx.net45.dll"
121139
4. The HelloWeb app should work the same as when running on the full desktop .NET Framework but now as a fully self-contained app with true side-by-side versioning support.
122140

123141
**NOTE: There are many APIs from the .NET Framework that are not yet available when running on Core CLR. This set should get smaller and smaller as time goes on.**

0 commit comments

Comments
 (0)