Skip to content

Commit

Permalink
Merge pull request #1001 from tbombach/getting-started
Browse files Browse the repository at this point in the history
Adding more instructions to the building code documentation
  • Loading branch information
tbombach committed May 17, 2016
2 parents 833c80d + 7ef8f8c commit 689423c
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions Documentation/building-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,35 @@ Prior to executing `gulp` to build and then test the code, make sure that the la

>gulp test
### Running AutoRest
#### Command Line
After building, the `AutoRest.exe` executable will be output to the `/binaries/net45/` folder. You can run it with the command line options specified in the [Command Line Interface](./cli.md) documentation.

#### Visual Studio
You can run (and debug) AutoRest by providing the command line parameters in the properties for the AutoRest project. To set these:
1. Open the properties for the AutoRest project.
2. Select the `Debug` tab.
3. Set the `Command line arguments` field in the `Start Options` section.
4. Build the entire solution to make sure the generators and modelers are built.
5. F5 the project.

#### Troubleshooting

#####If the Client Runtime project.json shows an error for Newtonsoft.Json, saying that the dependency does not support framework `.NETPortable,Version=4.5,Profile=111`
There is an issue with DNX 1.0.0-rc1 for optional frameworks: [https://github.com/aspnet/dnx/issues/2967](https://github.com/aspnet/dnx/issues/2967). If you have Xamarin files in the directory `C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETPortable\v4.5\Profile\Profile111\SupportedFrameworks`, then it will not be able to find the Newtonsoft.Json dependency.

#####If the task runner window in Visual Studio does not show any tasks
Make sure that you have run `npm install` in the root folder.

#####If `AutoRest.exe` complains about not having generators for each language
Make sure that you have built the entire `AutoRest.sln` solution.

#####If you see the error `gulp is not recognized as an internal or external command`
`gulp` is located at `C:\Users\[user]\AppData\Roaming\npm\gulp` in Windows after you install it globally.

#####If you see an error about the target framework not being available
Make sure that the correct DNX version is being used with `dnvm upgrade -r coreclr -arch x64`.

# Releasing AutoRest and ClientRuntimes

- [ ] Merge pending PRs into the master branch
Expand Down

0 comments on commit 689423c

Please sign in to comment.