Skip to content

Commit

Permalink
Update README.md and build scripts (#238)
Browse files Browse the repository at this point in the history
  • Loading branch information
pjcollins authored Jun 13, 2024
1 parent 2606225 commit 1c09dcc
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 40 deletions.
6 changes: 6 additions & 0 deletions CODE-OF-CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant
to clarify expected behavior in our community.

For more information, see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
2 changes: 0 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
xamarin-android-tools

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors
Expand Down
5 changes: 1 addition & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,11 @@ V ?= 0
include build-tools/scripts/msbuild.mk

all:
$(MSBUILD) /restore $(MSBUILD_FLAGS) Xamarin.Android.Tools.sln
$(MSBUILD) $(MSBUILD_FLAGS) Xamarin.Android.Tools.sln

clean:
-$(MSBUILD) $(MSBUILD_FLAGS) /t:Clean Xamarin.Android.Tools.sln

prepare:
nuget restore Xamarin.Android.Tools.sln

run-all-tests:
dotnet test -l "console;verbosity=detailed" -l trx \
tests/Xamarin.Android.Tools.AndroidSdk-Tests/Xamarin.Android.Tools.AndroidSdk-Tests.csproj
Expand Down
35 changes: 11 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# xamarin-android-tools
# android-tools

**xamarin-android-tools** is a repo to easily share code between the
[xamarin-android][x-a] repo and the Xamarin.Android commercial tooling,
**android-tools** is a repo to easily share code between the
[xamarin-android][android] repo and the .NET for Android commercial tooling,
such as IDE extensions, without requiring that the IDE extensions
submodule the entire **xamarin-android** repo, which is gigantic.
submodule the entire **android** repo, which is gigantic.

[x-a]: https://github.com/xamarin/xamarin-android
[android]: https://github.com/xamarin/xamarin-android

# Build Status

Expand All @@ -23,7 +23,7 @@ submodule the entire **xamarin-android** repo, which is gigantic.

# Build Requirements

**xamarin-android-tools** requires Mono 4.8 or later and `nuget`.
**-android-tools** requires .NET 6 or later.

# Build Configuration

Expand All @@ -38,18 +38,11 @@ The default `make all` target accepts the following optional

# Build

To build **xamarin-android-tools**:
To build **android-tools**:

msbuild /restore Xamarin.Android.Tools.sln
dotnet build Xamarin.Android.Tools.sln

Alternatively, first prepare the project:

make prepare

This will perform `nuget restore` and any other pre-build tasks
that need to be performed.

Next, run `make`:
Alternatively run `make`:

make

Expand All @@ -71,19 +64,13 @@ e.g. `bin\TestDebug`, contains unit tests and related files.
* `bin\$(Configuration)`: redistributable build artifacts.
* `bin\Test$(Configuration)`: Unit tests and related files.

# Contributing
# Distribution

Package versioning follows [Semantic Versioning 2.0.0](https://semver.org/).
The major version in the `nuget.version` file should be updated when a breaking change is introduced.
The minor version should be updated when new functionality is added.
The patch version will be automatically determined by the number of commits since the last version change.

This project has adopted the code of conduct defined by the Contributor Covenant
to clarify expected behavior in our community. For more information, see the
[.NET Foundation Code of Conduct](http://www.dotnetfoundation.org/code-of-conduct).

# Distribution

Xamarin.Android.Tools.AndroidSdk nupkg files are produced for every build which occurrs on [Azure Devops](https://dev.azure.com/xamarin/Xamarin/_build?definitionId=2&_a=summary).
To download one of these packages, navigate to the build you are interested in and click on the `Artifacts` button.

Expand Down Expand Up @@ -111,4 +98,4 @@ We use [Mono's Coding Guidelines](http://www.mono-project.com/community/contribu

# Reporting Bugs

We use [GitHub](https://github.com/xamarin/xamarin-android-tools/issues) to track issues.
We use [GitHub](https://github.com/dotnet/android-tools/issues) to track issues.
12 changes: 5 additions & 7 deletions azure-pipelines.yaml
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
name: Xamarin.Android.Tools $(Rev:r)
name: Android.Tools $(Rev:r)

trigger:
- main
- d16-*
- d17-*
- main
- release/*

pr:
- main
- d16-*
- d17-*
- main
- release/*

parameters:
- name: ApiScanSourceBranch
Expand Down
4 changes: 2 additions & 2 deletions build-tools/scripts/msbuild.mk
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
# $(MSBUILD): The MSBuild program to use. Defaults to `xbuild` unless overridden.
# $(MSBUILD_FLAGS): Additional MSBuild flags; contains $(CONFIGURATION), $(V), $(MSBUILD_ARGS).

MSBUILD = msbuild
MSBUILD = dotnet build
MSBUILD_FLAGS = /p:Configuration=$(CONFIGURATION) $(MSBUILD_ARGS)

ifeq ($(OS),Darwin)
Expand All @@ -35,7 +35,7 @@ ifneq ($(V),0)
MSBUILD_FLAGS += /v:diag
endif # $(V) != 0

ifeq ($(MSBUILD),msbuild)
ifeq ($(MSBUILD),dotnet build)
USE_MSBUILD = 1
endif # $(MSBUILD) == msbuild

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<Title>Xamarin.Android.Tools</Title>
<Authors>Xamarin</Authors>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<PackageProjectUrl>https://github.com/xamarin/xamarin-android-tools</PackageProjectUrl>
<PackageProjectUrl>https://github.com/dotnet/android-tools</PackageProjectUrl>
<Description>Xamarin tools for interacting with the Android SDK.</Description>
<Copyright>Copyright © Xamarin 2011-2016</Copyright>
<PackageTags>Xamarin;Xamarin.Android</PackageTags>
Expand Down

0 comments on commit 1c09dcc

Please sign in to comment.