From 93f06f92f9d514b55bb4aa596edd56bedd3f19e4 Mon Sep 17 00:00:00 2001 From: Nate McMaster Date: Mon, 14 Aug 2017 16:45:14 -0700 Subject: [PATCH] Update the README with basic instruction for getting started [ci skip] --- CONTRIBUTING.md | 2 +- README.md | 9 +++++++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 64ff041d5..952d5b87f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ Contributing -====== +============ Information on contributing to this repo is in the [Contributing Guide](https://github.com/aspnet/Home/blob/dev/CONTRIBUTING.md) in the Home repo. diff --git a/README.md b/README.md index 383bb6320..9525ebf76 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ KestrelHttpServer ================= -[![Join the chat at https://gitter.im/aspnet/KestrelHttpServer](https://badges.gitter.im/aspnet/KestrelHttpServer.svg)](https://gitter.im/aspnet/KestrelHttpServer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) - AppVeyor: [![AppVeyor](https://ci.appveyor.com/api/projects/status/nr0s92ykm57q0bjv/branch/dev?svg=true)](https://ci.appveyor.com/project/aspnetci/KestrelHttpServer/branch/dev) Travis: [![Travis](https://travis-ci.org/aspnet/KestrelHttpServer.svg?branch=dev)](https://travis-ci.org/aspnet/KestrelHttpServer) @@ -10,3 +8,10 @@ Travis: [![Travis](https://travis-ci.org/aspnet/KestrelHttpServer.svg?branch=dev This repo contains a cross-platform web server for ASP.NET Core. This project is part of ASP.NET Core. You can find samples, documentation and getting started instructions for ASP.NET Core at the [Home](https://github.com/aspnet/home) repo. + +## Building from source + +Before opening this project in Visual Studio or VS Code, execute `build.cmd /t:Restore` (Windows) or `./build.sh /t:Restore` (Linux/macOS). +This will download and initialize a few required build tools and packages. + +See [developer documentation](https://github.com/aspnet/Home/wiki) for more details.