From 14c2966563d9993b600463d086138e7dd1be6d68 Mon Sep 17 00:00:00 2001 From: tbombach Date: Mon, 2 May 2016 14:49:56 -0700 Subject: [PATCH 1/2] Adding more instructions to the building code documentation --- Documentation/building-code.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/Documentation/building-code.md b/Documentation/building-code.md index 648364f2ec..0dbe48c387 100644 --- 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 +
+ +
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 From 7ef8f8c2641cf8585da342b5cb7faa7db7cee26a Mon Sep 17 00:00:00 2001 From: Thomas Bombach Date: Mon, 16 May 2016 16:40:10 -0700 Subject: [PATCH 2/2] Updating documentation in the running AutoRest section --- Documentation/building-code.md | 35 ++++++++++++++++------------------ 1 file changed, 16 insertions(+), 19 deletions(-) diff --git a/Documentation/building-code.md b/Documentation/building-code.md index 0dbe48c387..c8290cd652 100644 --- a/Documentation/building-code.md +++ b/Documentation/building-code.md @@ -113,35 +113,32 @@ Prior to executing `gulp` to build and then test the code, make sure that the la ### 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. +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. +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 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 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 `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 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`.
- -
+#####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