Adding more instructions to the building code documentation

jianghaolu · May 3, 2016 · 14c2966 · 14c2966
1 parent 5101bc7
commit 14c2966
Showing 1 changed file with 32 additions and 0 deletions.
diff --git a/Documentation/building-code.md b/Documentation/building-code.md
@@ -111,6 +111,38 @@ 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 `/autorest/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
+<dl>
+
+<dt>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.</dt>
+<dd>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.</dd>
+
+<dt>If the task runner window in Visual Studio does not show any tasks.</dt>
+<dd>Make sure that you have run `npm install` in the root folder.<dd>
+
+<dt>If `AutoRest.exe` complains about not having generators for each language.</dt>
+<dd>Make sure that you have built the entire `AutoRest.sln` solution.</dd>
+
+<dt>If you see the error `gulp is not recognized as an internal or external command`.</dt>
+<dd>`gulp` is located at `C:\Users\[user]\AppData\Roaming\npm\gulp` in Windows after you install it globally.</dd>
+
+<dt>If you see an error about the target framework not being available.</dt>
+<dd>Make sure that the correct DNX version is being used with `dnvm upgrade -r coreclr -arch x64`.</dd>
+
+</dl>
+
 # Releasing AutoRest and ClientRuntimes
 
  - [ ] Merge pending PRs into the master branch