Skip to content

Commit 5391149

Browse files
Updated Readme.md with quick start info for OSX/Linux
Replaced the 'close and open your shell' message with on to just 'source kvm.sh'
1 parent 6447439 commit 5391149

File tree

2 files changed

+22
-9
lines changed

2 files changed

+22
-9
lines changed

README.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,35 @@ The samples provided are designed to show some of the features of the new framew
1111

1212
These are the current minimum requirements, they do not necesarilly represent our RTM minimum.
1313

14-
* Windows 7 or greater, though Core CLR will only work on Windows 8 today. If using Core CLR you will need to be on Windows 8 or above. At RTM the whole stack will support Windows 7+ and Windows Server 2008 R2+.
15-
* .NET 4.5.1 for hosting in IIS
16-
* Powershell 4. KVM is a Powershell script that makes use of types that older verisons of Powershell cannot load
14+
### Windows
15+
* Windows 7 or greater, though Core CLR will only work on Windows 8 today. If using Core CLR you will need to be on Windows 8 or above. At RTM the whole stack will support Windows 7+ and Windows Server 2008 R2+.
16+
* .NET 4.5.1 for hosting in IIS
17+
* Powershell 4. KVM is a Powershell script that makes use of types that older verisons of Powershell cannot load
18+
19+
20+
### OSX/Linux
21+
* Mono > 3.4.0 - Currently this means compiling mono from source from https://github.com/mono/mono
22+
* On Linux, you may need to run `mozroots --import` after installing mono
23+
* bash/zsh and curl
1724

18-
1925
#Getting Started
2026

2127
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)
2228

2329
* Clone the repository
24-
* On the command line execute ```kvmsetup.cmd```
30+
* On the command line execute
31+
* ```kvmsetup.cmd``` on Windows or
32+
* ```sh kvmsetup.sh && source ~/.kre/kvm/kvm.sh``` on OSX/Linux
2533
* This command will setup your environment, getting it ready to install a version of the runtime. It adds kvm to your path and puts it in your user profile.
2634
* Execute ```kvm install 0.1-alpha-build-0421```. This command will download the named version of the KRE and put it on your user profile ready to use. You can get the latest version by running ```kvm upgrade``` but 0421 was the last version explicitly tested. see the [KVM page](https://github.com/aspnet/Home/wiki/version-manager) for more information on KVM.
2735
* Navigate to samples\ConsoleApp
2836
* Run ```kpm restore```. This downloads the System.Console package so the app can do Console.WriteLine
29-
* Run ```K run```
37+
* Run ```k run```
3038
* You should see a message saying "Hello World"
31-
* Type ```SET KRE_TRACE=1```
32-
* Run ```K run```
39+
* Type
40+
* ```SET KRE_TRACE=1``` on Windows or
41+
* ```export KRE_TRACE=1``` on OSX/Linux
42+
* Run ```k run```
3343
* You should now see compiler output as well as the "Hello World" message
3444

3545
```
@@ -84,6 +94,7 @@ If you can do all of the above then everything should be working. You can try ou
8494

8595
#Switching to Core CLR
8696

97+
8798
By default when running the applications you are running against Desktop CLR (4.5), you can change that using the KVM command.
8899

89100
1. Run ```kvm install 0.1-alpha-build-0421 -svrc50``` This command gets the latest Core CLR version of the k runtime and sets it as your default. The -svrc50 switch tells it to use Core CLR, you can use -svr50 to target desktop again.
@@ -93,6 +104,8 @@ By default when running the applications you are running against Desktop CLR (4.
93104

94105
**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.**
95106

107+
**NOTE: There is no Core CLR currently on OSX/Linux. There is only a single platform (mono45) and a single architecture (x86).**
108+
96109
#Core CLR Packages
97110

98111
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.

kvmsetup.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,4 +74,4 @@ else
7474
fi
7575
fi
7676

77-
echo "=> Close and reopen your terminal to start using kvm"
77+
echo "=> Type 'source $KRE_USER_HOME/kvm/kvm.sh' to start using kvm"

0 commit comments

Comments
 (0)