huahaofeng
/
aspnetcore
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Getting Started/Build Documentation (#1311) 

* Added getting-started documentation.

- High-level getting started docs.
- Troubleshooting the build docs.
- Build details docs.
This commit is contained in:
Tony Compton 2018-02-15 12:21:00 -05:00 committed by David Fowler
parent 551158c239
commit 78612fc4b0
2 changed files with 22 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -55,6 +55,6 @@ Once you've installed the NPM modules, they will be located in the `node_modules
To run a complete build on command line only, execute `build.cmd` or `build.sh` without arguments.
The build requires NodeJS (6.9 or newer) and npm to be installed on the machine.
If this is your first time building *SignalR* please see the [Getting Started](docs/GettingStarted.md) for more information about project dependencies and other build-related information specific to *SignalR*.
See [developer documentation](https://github.com/aspnet/Home/wiki) for more details.
See [developer documentation](https://github.com/aspnet/Home/wiki) for general information on building and contributing to this and other [aspnet](https://github.com/aspnet) repositories.

20
docs/GettingStarted.md Normal file
View File

@ -0,0 +1,20 @@
# Getting Started
## Dependencies
In order to successfully build and test *SignalR* you'll need to ensure that your system has the following installed:
* [NodeJS](https://nodejs.org/) version 6.9 or later
* NPM *(typically bundled with NodeJS)*
## How To Build
Full instructions for how to build repositories within the [aspnet](https://github.com/aspnet) family of repositories can be found [in the Home repository](https://github.com/aspnet/Home/wiki/Building-from-source).
The short-hand version of that is to simply run the `build.cmd` or `build.sh` script that's in the root of the *SignalR* repository. The build script will automatically install the necessary .NET SDK version.
If, after running `build.cmd` or `build.sh`, you did not get a successful build, please refer to the [Troubleshooting](#troubleshooting) section below. If your problem isn't covered, please check that you've met all of the prerequisites. If you still can't get the solution to build successfully, please open an issue so that we might assist and please consider updating this documentation to help others in the future.
## Troubleshooting
Below are some tips for troubleshooting common issues.
### Project Load Failures in Visual Studio
In order to property load several of the projects in the solution, it is necessary that `%USERPROFILE%\.dotnet\x64` be in your `PATH` variable. If you experience issues loading projects in Visual Studio, please ensure that your `PATH` is configured correctly.