diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 110 |
1 files changed, 27 insertions, 83 deletions
@@ -1,97 +1,41 @@ -# Getting Started with ASP.NET Core
[![Join the chat at https://gitter.im/aspnet/Home](https://badges.gitter.im/aspnet/Home.svg)](https://gitter.im/aspnet/Home?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-This guide is designed to get you started building applications with the latest development versions ASP.NET Core. This means nightly builds and potentially broken or unstable packages.
+**This is not the homepage for ASP.NET Core.** This is the home page of our source code repositories and is intended for those contributing to ASP.NET Core or using bleeding edge nightly builds.
-If you want a more stable, released, experience then you should go to https://www.asp.net/vnext.
+If you want a more stable, released, experience or getting started instructions then go to one of the following:
-## What you need
+- [.NET Homepage](http://dot.net)
+Check out dot.net for released versions of .NET, getting started guides, and learning resources.
-The key part of working with development feeds is getting your environment set up so that you can acquire and switch to new builds of the DNX. Once you have that then it is just a matter of pulling the latest packages from the development MyGet feed.
+- [ASP.NET Core Documentation](http://docs.asp.net) or [.NET Core Documentation](http://microsoft.com/net/core). We intend to merge these in the future.
-In order to be able to get new builds of the DNX, and switch between them, you need to get the .NET Version Manager (DNVM) command line tool.
+If you want to follow along with development of ASP.NET Core then go to:
-## Getting Started on Windows
-
-The easiest way to get started on Windows is to grab the latest version of Visual Studio 2015, which can be found [here](https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx).
-
-Visual Studio will install DNVM for you, so if you open a developer command prompt and type `dnvm` you should get some help text.
-
-### Upgrading DNVM or running without Visual Studio
-
-If you don't want to install Visual Studio or want to upgrade DNVM to the latest version then you need to run the following command:
-
-####CMD
-```
-@powershell -NoProfile -ExecutionPolicy unrestricted -Command "&{$Branch='dev';$wc=New-Object System.Net.WebClient;$wc.Proxy=[System.Net.WebRequest]::DefaultWebProxy;$wc.Proxy.Credentials=[System.Net.CredentialCache]::DefaultNetworkCredentials;Invoke-Expression ($wc.DownloadString('https://raw.githubusercontent.com/aspnet/Home/dev/dnvminstall.ps1'))}"
-```
-
-####Powershell
-```
-&{$Branch='dev';$wc=New-Object System.Net.WebClient;$wc.Proxy=[System.Net.WebRequest]::DefaultWebProxy;$wc.Proxy.Credentials=[System.Net.CredentialCache]::DefaultNetworkCredentials;Invoke-Expression ($wc.DownloadString('https://raw.githubusercontent.com/aspnet/Home/dev/dnvminstall.ps1'))}
-```
-
-This will download the DNVM script and put it in your user profile. You can check the location of DNVM by running the following in a cmd prompt:
-
-```
-where dnvm
-```
-
-> If the output of `where dnvm` shows a program files location before the user profile, or doesn't show an entry in user profile, then the install has either failed or your PATH is incorrect. After installing dnvm you should have the dnvm script in `%USERPROFILE%\.dnx\bin` and that path needs to be on your PATH.
-
-## OS X
-
-See the instructions on the ASP.NET Core Documentation site: [Installing ASP.NET Core on Mac OS X](https://docs.asp.net/en/latest/getting-started/installing-on-mac.html)
-
-## Linux
-
-See the instructions on the ASP.NET Core Documentation site: [Installing ASP.NET Core on Linux](https://docs.asp.net/en/latest/getting-started/installing-on-linux.html)
-
-# Running an application
-
-Now that you have DNVM, you need to use it to download a DNX to run your applications with:
-
-```
-dnvm upgrade
-```
-
-> DNVM has the concept of a stable and unstable feed. Stable defaults to NuGet.org while unstable defaults to our dev MyGet feed. So if you add `-u` or `-unstable` to any of the install or upgrade commands you will get our latest CI build of the DNX instead of the one last released on NuGet.
-
-DNVM works by manipulating your path. When you install a runtime it downloads it and adds the path to the dnx binary to your `PATH`. After doing upgrade you should be able to run `dnvm list` and see an active runtime in the list.
-
-You should also be able to run `dnx` and see the help text of the `dnx` command.
-
-## Running the samples
-
-1. Clone the ASP.NET Core Home repository: https://github.com/aspnet/home
-2. Change directory to the folder of the sample you want to run
-3. Run ```dnu restore``` to restore the packages required by that sample.
-4. You should see a bunch of output as all the dependencies of the app are downloaded from MyGet.
-5. Run the sample using the appropriate DNX command:
- - For the console app run `dnx run`.
- - For the web apps run `dnx kestrel`.
-6. You should see the output of the console app or a message that says the site is now started.
-7. You can navigate to the web apps in a browser by navigating to `http://localhost:5004`
-
-# Documentation and Further Learning
-
-## [Community Standup](https://www.youtube.com/playlist?list=PL0M0zPgJ3HSftTAAHttA3JQU4vOjXFquF)
+- [Community Standup](http://live.asp.net)
The community standup is held every week and streamed live to YouTube. You can view past standups in the linked playlist.
-
-If you have questions you can also jump online during the next standup and have them answered live.
-
-## [Wiki Documentation](https://github.com/aspnet/Home/wiki)
-We have some useful documentation on the wiki of this Repo. This wiki is a central spot for docs from any part of the stack.
-
-If you see errors, or want some extra content, then feel free to create an issue or send a pull request (see feedback section below).
-
-## [ASP.NET/vNext](https://www.asp.net/vnext)
-The vNext page on the ASP.NET site has links to some TechEd videos and articles with some good information about ASP.NET Core (formerly known as ASP.NET 5).
-
-## [Roadmap] (https://github.com/aspnet/Home/wiki/Roadmap)
+- [Roadmap](https://github.com/aspnet/Home/wiki/Roadmap)
The schedule and milestone themes for ASP.NET Core.
+## Getting ASP.NET Core
+
+- Stable builds of ASP.NET Core should be obtained from http://dot.net.
+- If you want to use nightlies then you need to:
+ - Obtain the latest nightly CLI from http://github.com/dotnet/cli
+ - Add a NuGet.Config to your app with the following content:
+ ```xml
+ <?xml version="1.0" encoding="utf-8"?>
+ <configuration>
+ <packageSources>
+ <clear />
+ <add key="AspNetCI" value="https://www.myget.org/F/aspnetvnext/api/v3/index.json" />
+ <add key="NuGet.org" value="https://api.nuget.org/v3/index.json" />
+ </packageSources>
+ </configuration>
+ ```
+ *NOTE: This NuGet.Config should be with your application unless you want nightly packages to potentially start being restored for other apps on the machine.*
+ - Change your applications dependencies to have a `*` to get the latest version, `1.0.0-*` for example.
+
## Repos and Projects
These are some of the most common repos:
|