Skip to content
This repository has been archived by the owner on Nov 6, 2024. It is now read-only.

Commit

Permalink
readme.md update how to build
Browse files Browse the repository at this point in the history
  • Loading branch information
moljac committed Jun 11, 2019
1 parent 5a4661b commit 906668f
Showing 1 changed file with 26 additions and 15 deletions.
41 changes: 26 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,25 @@ Xamarin creates and maintains Xamarin.Android bindings for the Google Play Servi

The build script for this project uses [Cake](http://cakebuild.net). To run the build, you can use one of the bootstrapper files either for Mac or Windows (experimental support only):

The bootstrapper script will automatically download Cake.exe and all the required tools and files into the `./tools/` folder.

The following targets can be specified:

- `ci` builds the kitchen sink - what we run in CI
- `libs` builds the class library bindings (depends on `binderate`)
- `binderate` downloads the external dependencies and generates folder structure
- `samples` builds all of the samples (depends on `libs`)
- `nuget` builds the nuget packages (depends on `libs`)
- `clean` cleans up everything

***NOTE***: The `binderate` build task may take awhile to run as it downloads several large dependencies.

You may want to consider passing `--verbosity diagnostic` (or `-Verbosity diagnostic` on Windows) to the bootstrapper to enable more verbose output, including downloading progress.

**Mac**:

```
sh ./build.sh --target=binderate && sh ./build.sh --target=libs && sh ./build.sh --target=nuget
sh ./build.sh --target=binderate && sh ./build.sh --target=libs
```

Optionally run:
Expand All @@ -51,7 +66,7 @@ before the build.
**Windows:**

```
./build.ps1 --target=binderate && ./build.ps1 --target=libs && ./build.ps1 --target=nuget
./build.ps1 --target=binderate ; ./build.ps1 --target=libs
```

Optionally run:
Expand All @@ -62,23 +77,19 @@ Optionally run:

before the build.

To build nuget packages, samples and API diff:

**Mac**:

The bootstrapper script will automatically download Cake.exe and all the required tools and files into the `./tools/` folder.

The following targets can be specified:

- `ci` builds the kitchen sink - what we run in CI
- `libs` builds the class library bindings (depends on `binderate`)
- `binderate` downloads the external dependencies and generates folder structure
- `samples` builds all of the samples (depends on `libs`)
- `nuget` builds the nuget packages (depends on `libs`)
- `clean` cleans up everything

***NOTE***: The `binderate` build task may take awhile to run as it downloads several large dependencies.
```
sh ./build.sh --target=nuget && sh ./build.sh --target=samples && sh ./build.sh --target=diff
```

You may want to consider passing `--verbosity diagnostic` (or `-Verbosity diagnostic` on Windows) to the bootstrapper to enable more verbose output, including downloading progress.
**Windows:**

```
./build.ps1 --target=nuget ; ./build.ps1 --target=samples ; ./build.ps1 --target=diff
```

### Working in Visual Studio / Xamarin Studio

Expand Down

0 comments on commit 906668f

Please sign in to comment.