Skip to content

Commit 206f745

Browse files
committed
fix some typos and updated some parts of the readme. Added GetRuntime.cmd
1 parent 52563e3 commit 206f745

File tree

2 files changed

+38
-15
lines changed

2 files changed

+38
-15
lines changed

GetRuntime.cmd

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
@echo off
2+
cd %~dp0
3+
4+
SETLOCAL
5+
SET CACHED_NUGET=%LocalAppData%\NuGet\NuGet.exe
6+
7+
IF EXIST %CACHED_NUGET% goto copynuget
8+
echo Downloading latest version of NuGet.exe...
9+
IF NOT EXIST %LocalAppData%\NuGet md %LocalAppData%\NuGet
10+
@powershell -NoProfile -ExecutionPolicy unrestricted -Command "$ProgressPreference = 'SilentlyContinue'; Invoke-WebRequest 'https://www.nuget.org/nuget.exe' -OutFile '%CACHED_NUGET%'"
11+
12+
:copynuget
13+
IF EXIST .nuget\nuget.exe goto restore
14+
md .nuget
15+
copy %CACHED_NUGET% .nuget\nuget.exe > nul
16+
17+
:restore
18+
IF EXIST packages\KoreBuild goto run
19+
.nuget\NuGet.exe install ProjectK -o packages -nocache -pre

README.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ The Preview repository is a place for the ASP.NET Insiders to log issues and dis
44

55
The samples provided are designed to show some of the features of the new framework as well as setting up a sandbox for you to try out new drops of functionality as they come out. The NuGet.config file in the repo points to a private MyGet feed that has all the packages being developed. The feed is updated every time a full build succeeds.
66

7-
**The K.cmd file in the root of this repo is designed to be able to be put in your path. It will probe various locations relative to your current directory to find the KRuntime that it should" use. All the examples after this will assume you've done this, so that you can just type K Run from anywhere. If you choose not to then add the appropriate number of folder traversals (..\\) before each K command.**
7+
**The K.cmd file in the root of this repo is designed to be able to be put in your path. It will probe various locations relative to your current directory to find the KRuntime that it should use. All the steps after this will assume you've done this, so that you can just type ```K Run``` from anywhere. If you choose not to then add the appropriate number of folder traversals (..\\) before each K command.**
88

9-
#Available Sample
9+
#Samples
1010

1111
##Sandbox Samples
1212

@@ -17,41 +17,45 @@ These samples, in this repo, are just basic starting points for you to experimen
1717
+ HelloWebFx. This sample is a basic MVC app. It is not designed to show all the functionality of the new web stack, but to give you a starting point to play with features.
1818

1919
##Feature Samples
20-
The Entropy repo contains examples of specific features in isolation. Each directory contains just enough code to show an aspect of a feature.
20+
The Entropy repo contains samples of specific features in isolation. Each directory contains just enough code to show an aspect of a feature.
2121

2222
##Application Samples
2323
MVC Music Store and BugTracker application are both being ported. Each of these have their own repository that you can look at as they are working.
2424

2525
#Running the samples
2626

27+
##Bootstrapping the runtime
28+
Before you can use the runtime commands to launch your application, you need to have the runtime commands. To do this there is a GetRuntime.cmd file in the root of the repository.
29+
30+
1. Run ```GetRuntime.cmd```
31+
2. This should use NuGet.exe to get the runtime from MyGet and put it in a packages folder. One of the things currently containined in the runtime is a modified version of NuGet.exe that you should use for everything other than getting the runtime itself.
32+
33+
##Running HelloWeb
34+
2735
1. Clone the repository
2836
2. Change directory to Preview\Samples\HelloWeb
29-
3. Run "K restore"
30-
4. You should see a bunch of output as all the dependencies of the app are downloaded from MyGet. This may take a while if MyGet is slow.
31-
5. Run "K web"
37+
3. Run ```K restore```
38+
4. You should see a bunch of output as all the dependencies of the app are downloaded from MyGet. The K commands all operate on the app that is in the current directory.
39+
5. Run ```K web```
3240
6. You should see build output and a message to show the site is now started
3341
7. Navigate to "http://localhost:5001"
3442
8. You should see the welcome page
3543
9. Navigate to "http://localhost:5001/image.jpg"
3644
10. You should see an image served with the static file middleware
3745

38-
If you can do all of the above then everything should be working. You can try out the WebFx sample now to see some more of the new stack.
46+
If you can do all of the above then everything should be working. You can try out the WebFx sample now to see some more of the new stack. You should run ```K restore``` before using any sample for the first time.
3947

4048
#Switching to Core CLR
4149

4250
By default when running the applications you are running against Desktop CLR (4.5), you can change that by setting the TARGET_FRAMEWORK variable:
4351

44-
1. Run "set TARGET_FRAMEWORK=k10"
45-
2. Run "K web"
52+
1. Run ```set TARGET_FRAMEWORK=k10```
53+
2. Run ```K web```
4654
3. The first line of your output should say "Loaded Module: klr.core45.dll" instead of "Loaded Module: klr.net45.dll"
4755
4. The HelloWeb app should work the same as when running on Desktop CLR.
4856

49-
**NOTE: There are going to be parts of the stack that work on Desktop but do not work on Core CLR. This set should get smaller and smaller as time goes on, but it is entirely likely as you use Core CLR you will hit errors that can't be worked around as the Core CLR surface area just does not exist yet. An example of this type of problem is using EF with a database. There are not currently any real database providers that work on Core CLR, so you will be restricted to in-memory EF on Core CLR.**
50-
51-
#Packages in the repository
52-
53-
Installing packages from MyGet can be very slow. In order to save the time of getting the Runtime itself, which is the largest of our packages, we checked it in. We will update it periodically as important features are added. The package is also on MyGet if you want to get the latest version yourself.
57+
**NOTE: There are going to be parts of the stack that work on Desktop but do not work on Core CLR. This set should get smaller and smaller as time goes on, but it is entirely likely as you use Core CLR you will hit errors that can't be worked around as the Core CLR surface area just does not exist yet. An example of this type of problem is using Entity Framework with a database. There are not currently any real database providers that work on Core CLR, so you will be restricted to in-memory EF on Core CLR.**
5458

5559
#Core CLR Packages
5660

57-
Currently the BCL is broken into some fairly fine grained packages, which was one of the goals of this effort. However, the packages that exist today do not necesarilly represent the list of packages that we will end up with. We are still experimenting with what makes sense to be a package and what the experience should be.
61+
Currently the BCL is split into some fairly fine grained packages, which was one of the goals of this effort. However, the packages that exist today do not necessarily represent the list of packages that we will end up with. We are still experimenting with what makes sense to be a package and what the experience should be.

0 commit comments

Comments
 (0)