Skip to content

Commit bbb5bb7

Browse files
authored
Update setup instructions in BuildFromSource (#24025)
1 parent 30c33aa commit bbb5bb7

File tree

1 file changed

+19
-16
lines changed

1 file changed

+19
-16
lines changed

docs/BuildFromSource.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,22 @@ Building ASP.NET Core from source allows you to tweak and customize ASP.NET Core
44

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

7+
## Clone the source code
8+
9+
ASP.NET Core uses git submodules to include the source from a few other projects.
10+
11+
For a new copy of the project, run:
12+
13+
```ps1
14+
git clone --recursive https://github.com/dotnet/aspnetcore
15+
```
16+
17+
To update an existing copy, run:
18+
19+
```ps1
20+
git submodule update --init --recursive
21+
```
22+
723
## Install pre-requisites
824

925
### Windows
@@ -52,22 +68,6 @@ Building ASP.NET Core on macOS or Linux requires:
5268
* OpenJDK <https://jdk.java.net/>
5369
* Oracle's JDK <https://www.oracle.com/technetwork/java/javase/downloads/index.html>
5470
55-
## Clone the source code
56-
57-
ASP.NET Core uses git submodules to include the source from a few other projects.
58-
59-
For a new copy of the project, run:
60-
61-
```ps1
62-
git clone --recursive https://github.com/dotnet/aspnetcore
63-
```
64-
65-
To update an existing copy, run:
66-
67-
```ps1
68-
git submodule update --init --recursive
69-
```
70-
7171
**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>
7272
7373
## Building in Visual Studio
@@ -86,6 +86,9 @@ Before opening our .sln/.slnf files in Visual Studio or VS Code, you need to per
8686
> :bulb: Pro tip: you will also want to run this command after pulling large sets of changes. On the master
8787
> branch, we regularly update the versions of .NET Core SDK required to build the repo.
8888
> You will need to restart Visual Studio every time we update the .NET Core SDK.
89+
> To allow executing the setup script, you may need to update the execution policy on your machine.
90+
You can do so by running the `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser` command
91+
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).
8992

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

0 commit comments

Comments
 (0)