From 306513a844d5b56be07f73126d189db4bb98a664 Mon Sep 17 00:00:00 2001 From: Praburaj Date: Thu, 1 May 2014 11:06:26 -0700 Subject: [PATCH] Adding some more formatting to the readme.md to make it more readable. --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 0d028bfc8b..d68fe2928c 100644 --- a/README.md +++ b/README.md @@ -10,30 +10,30 @@ The first thing we need to do is setup the tools required to build and run an ap * If you already have ```kvm``` installed on the machine ignore above steps. ### Run the application: -1. Run build.cmd to restore all the necessary packages and generate project files -2. Open a command prompt and cd \src\\ -3. [Helios]: - 4. Helios.cmd to launch the app on IISExpress (Application started at URL http://localhost:5001/). -4. [SelfHost]: - 5. Run ```k web``` (Application started at URL http://localhost:5002/) -5. [CustomHost]: - 6. Run ```k run``` (This hosts the app in a console application - Application started at URL http://localhost:5003/) +1. Run ```build.cmd``` to restore all the necessary packages and generate project files +2. Open a command prompt and cd ```\src\\``` +3. **[Helios]:** + 4. ```Helios.cmd``` to launch the app on IISExpress (Application started at URL **http://localhost:5001/**). +4. **[SelfHost]:** + 5. Run ```k web``` (Application started at URL **http://localhost:5002/**) +5. **[CustomHost]:** + 6. Run ```k run``` (This hosts the app in a console application - Application started at URL **http://localhost:5003/**) ### Switching between Desktop CLR and CoreCLR: By default the app runs on desktop CLR. To switch to run the app on CoreCLR set environment variable ```SET TARGET_FRAMEWORK=k10```. To switch back to desktop CLR ```SET TARGET_FRAMEWORK=``` to empty. ### Adding a new package: 1. Edit the project.json to include the package you want to install -2. Do a build.cmd - This will restore the package and regenerate your csproj files to get intellisense for the installed packages. +2. Do a ```build.cmd``` - This will restore the package and regenerate your csproj files to get intellisense for the installed packages. ### Work against the latest build: -1. Run Clean.cmd - This will clear all the packages and any temporary files generated -2. Continue the topic "Steps to run the application" +1. Run ```Clean.cmd``` - This will clear all the packages and any temporary files generated +2. Continue the topic "Run the application" ### Work against LKG Build: -1. Everytime you do a build.cmd you will get the latest packages of all the included packages. If you would like to go back to an LKG build checkout the LKG.json file in the MusicStore folder. +1. Everytime you do a ```build.cmd``` you will get the latest packages of all the included packages. If you would like to go back to an LKG build checkout the *LKG.json* file in the MusicStore folder. 2. This is a captured snapshot of build numbers which worked for this application. This LKG will be captured once in a while. ### Note: -1. The scripts Helios.cmd, SelfHost.cmd and CustomHost.cmd will start the application on different ports. To change the port or URL modify the scripts or project.json (in case of selfhost alone). +1. Application is started on different ports on different hosts. To change the port or URL modify ```Helios.cmd``` or project.json commands section in case of self-host and customhost. 2. Use Visual studio only for editing & intellisense. Don't try to build or run the app from Visual studio. \ No newline at end of file