Skip to content

Update setup instructions in BuildFromSource #24025

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
1 commit merged into from
Jul 16, 2020
Merged

Update setup instructions in BuildFromSource #24025

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 19 additions & 16 deletions docs/BuildFromSource.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,22 @@ Building ASP.NET Core from source allows you to tweak and customize ASP.NET Core

See <https://github.com/dotnet/aspnetcore/labels/area-infrastructure> for known issues and to track ongoing work.

## Clone the source code

ASP.NET Core uses git submodules to include the source from a few other projects.

For a new copy of the project, run:

```ps1
git clone --recursive https://github.com/dotnet/aspnetcore
```

To update an existing copy, run:

```ps1
git submodule update --init --recursive
```

## Install pre-requisites

### Windows
Expand Down Expand Up @@ -52,22 +68,6 @@ Building ASP.NET Core on macOS or Linux requires:
* OpenJDK <https://jdk.java.net/>
* Oracle's JDK <https://www.oracle.com/technetwork/java/javase/downloads/index.html>

## Clone the source code

ASP.NET Core uses git submodules to include the source from a few other projects.

For a new copy of the project, run:

```ps1
git clone --recursive https://github.com/dotnet/aspnetcore
```

To update an existing copy, run:

```ps1
git submodule update --init --recursive
```

**NOTE** some ISPs have been know to use web filtering software that has caused issues with git repository cloning, if you experience issues cloning this repo please review <https://help.github.com/en/github/authenticating-to-github/using-ssh-over-the-https-port>

## Building in Visual Studio
Expand All @@ -86,6 +86,9 @@ Before opening our .sln/.slnf files in Visual Studio or VS Code, you need to per
> :bulb: Pro tip: you will also want to run this command after pulling large sets of changes. On the master
> branch, we regularly update the versions of .NET Core SDK required to build the repo.
> You will need to restart Visual Studio every time we update the .NET Core SDK.
> To allow executing the setup script, you may need to update the execution policy on your machine.
You can do so by running the `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser` command
in PowerShell. For more information on execution policies, you can read the [execution policy docs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-executionpolicy).

2. Use the `startvs.cmd` script to open Visual Studio .sln/.slnf files. This script first sets the required
environment variables.
Expand Down