Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wub committed Mar 20, 2016
1 parent d840494 commit 1151a58
Showing 1 changed file with 27 additions and 25 deletions.
52 changes: 27 additions & 25 deletions README.md
Expand Up @@ -3,47 +3,49 @@
The Microsoft Azure SDK for .NET allows you to build applications
that take advantage of scalable cloud computing resources.

### Target Frameworks:
### Target frameworks

* .NET Framework 4.0 and newer.
* .NET Portable Framework, using profile 102
- .NET Framework 4.0 and newer.
- .NET Portable Framework, using profile 102

### Prerequisites:
* Visual Studio 2013 RTM with update 2 at minimum
### Prerequisites

### To build:
- Visual Studio 2013 RTM Update 2 (at minimum)

Using Visual Studio:
## Building

- Open any solution, say, "src\ResourceManagement\Compute\Compute.sln".
- Invoke "build" command.
- Most solutions support 3 solution configurations, "Net40", "Net45", and "Portable". you can use "Configuration Manager" to switch and build.
#### Using Visual Studio

Using the command line:
- Open any solution, say, [`src\ResourceManagement\Compute\Compute.sln`](src/ResourceManagement/Compute/Compute.sln).
- Invoke the "build" command.
- Most solutions support 3 solution configurations, "Net40", "Net45", and "Portable". You can use "Configuration Manager" to switch and build.

- Ensure "msbuild.exe" is under environment pathes, which you can run the command file pre-installed by Visual Studio.
*C:\Program Files (x86)\Microsoft Visual Studio 12.0\Common7\Tools\VsDevCmd.bat*
- Under repository root, there is a "build.proj", which you can build with. For example, to build a nuget package for compute management, run:
*msbuild build.proj /t:build;package /p:scope=ResourceManagement\Compute*
- For other supported flags, check out the top comment section inside "build.proj".
#### Using the command line

- Use `VsDevCmd` to Ensure "msbuild.exe" is in your path (replace "12.0" with your version):
`C:\Program Files (x86)\Microsoft Visual Studio 12.0\Common7\Tools\VsDevCmd.bat`
- You can build with [`build.proj`](build.proj). For example, to build a nuget package for compute management, run:
`msbuild build.proj /t:build;package /p:scope=ResourceManagement\Compute`
- For other supported flags, check out the top comment section inside [`build.proj`](build.proj).

### To run the tests:
## Tests

Using Visual Studio:
#### Using Visual Studio

- Most test projects only build for "net45". To run them, switch solution configuration to "net45".
- Build.
- "Test Explorer" window will get populated with tests. Go select and invoke.
- "Test Explorer" window will be populated with tests. Go select and invoke.

Using the command line:
#### Using the command line

- Refer to the "To build" section to get the command window set up.
- Invoke "Test" target from "Build.proj". Likely, you need to build test project first, so put in "build" target as well.
*msbuild build.proj /t:build;test /p:scope=ResourceManagement\Compute*
- Refer to the [building](#building) section to get the command window set up.
- Invoke the "Test" target from [`build.proj`](build.proj). It's likely you'll need to build the test project first, so add the "build" target as well:
`msbuild build.proj /t:build;test /p:scope=ResourceManagement\Compute`

## Issues with generated code

Much of the SDK code is generated from metadata specs about the REST APIs. Don't submit PRs that modify generated code. Instead, file an issue describing the problem, *or* refer to the the [AutoRest project][AutoRest] to view and modify the generator.

### Issues with Generated Code
Much of the SDK code is generated from metadata specs about the REST APIs. Do not submit PRs that modify generated code. Instead, file an issue describing the problem, OR refer to the the [AutoRest project][AutoRest] to view and modify the generator.
>Note: the generated code in the master branch is from a private project. The SDK is migrating to use AutoRest with generated code described by Swagger. Not all of the generator code is public yet, but it will be over the next few weeks. (July 2015).
[AutoRest]: https://github.com/azure/autorest

0 comments on commit 1151a58

Please sign in to comment.