Skip to content

Commit

Permalink
make v1 / v2 docs clearer
Browse files Browse the repository at this point in the history
  • Loading branch information
dansiegel committed Mar 1, 2021
1 parent 5e6808c commit 7eae3a6
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 1 deletion.
6 changes: 5 additions & 1 deletion ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,24 @@

There is a lot of talk these days about DevOps. One of the problems with DevOps is that it can be really challenging. Far too many companies suffer from reliance on poor practices that their Development teams know need to be fixed. Today we have a variety of Build Systems that are at our disposal and we no longer need to rely on such poor practices. Mobile.BuildTools can help turn your run of the mill project into a streamlined DevOps masterpiece. Best of all because the Mobile.BuildTools simply provide new targets for MSBuild it works absolutely EVERYWHERE that MSBuild itself is installed!

> **IMPORTANT** Version 1.x is no longer under development. This is considered a legacy version. Docs for v1.x are located in the Wiki. For those wishing to use the more powerful API's described in the mobilebuildtools.com docs site please use the v2.0 previews.
#### Background

As part of my frustration at how challenging it was to go from File -> New Solution to a base project that was ready to put into a DevOps pipeline, I set out to create the Prism QuickStart Templates. Part of the templates included many of the features you see in the Mobile.BuildTools. As time went on I realized the need to decouple the tools from the template so as new features were added, or bugs fixed it could be more easily added.

## Support

If this project helped you reduce time to develop and made your app better, please be sure to star the project & help support Dan.
If this project helped you reduce time to develop and made your app better, please be sure to star the project. Also please consider becoming a GitHub sponsor. I spend hundreds if not over 1000 hours a year working on Open Source and your financial contributions help me spend time working on new features and fixing bugs that affect your apps.

[![GitHub Sponsors](https://github.blog/wp-content/uploads/2019/05/mona-heart-featured.png?fit=600%2C315)](https://xam.dev/sponsor-buildtools)


## Samples

- [App Config Demo](samples/AppConfigSample) - Sample Xamarin app using the new app.config. This sample uses Xamarin.Forms with Prism to show how you can use this with Dependency Injection and keep your apps testable with the IConfigurationManager rather than using all statics. NOTE: This project does not take advantage of build time transformations.
- [BuildToolsSample](samples/BuildToolsSample) - Sample Xamarin app using various build time generated helpers from the Mobile.BuildTools.


## Mobile.BuildTools

Expand Down
3 changes: 3 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ The Mobile.BuildTools is an easy to use NuGet package that adds new MSBuild targ

The Mobile.BuildTools are a collection of MSBuild Tasks that help make MSBuild smarter in handling the build process for CI/CD with Mobile Applications. The library was born from a desire to share build processes from one app to the next without having to copy and paste a bunch of build scripts each of which could easily end up out of date. Because the Mobile.BuildTools simply provides MSBuild Tasks, this adds nothing to the size of your application and if being used on a project that will be packed and shared, you can set the PackageReference's PrivateAssets to all.

!!! warning "NOTE"
The docs on this site are specific to the Mobile.BuildTools v2.0. For those still using v1.4 please refer to the Wiki on GitHub.

## Support

This project is maintained by Dan Siegel. If this project has helped you please consider sponsoring Dan on GitHub. Your contributions help make great open source projects possible.
Expand Down
19 changes: 19 additions & 0 deletions samples/BuildToolsSample/ReadMe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# BuildToolsSample

This is a sample app showing how you might use some features of the Mobile.BuildTools. Note that you may have issues loading this in Visual Studio. It's best built from the command line in Visual Studio Code.

## Secrets

This uses several secrets that are defined in the buildtools.json. You might start by copying the following json into a file named secrets.json which can be placed either in the solution root directory (this directory) or in the project directory.

```json
{
"AppDisplayName": "Build Tools",
"Message": "Hello Mobile.BuildTools from secrets.json",
"AppCenterId": "00000000-0000-0000-0000-000000000000",
"Backend": "http://awesomebackend.azurewebsites.com",
"ClientId": "00000000-0000-0000-0000-000000000000"
}
```

Note that secrets can be combined dynamically with a secrets.json in the solution root and in the project directory as well as by adding configuration based secrets like `secrets.Debug.json` which will conditionally be brought in. This will eventually support reuse across projects and app manifests like the Info.plist and AndroidManifest.xml.

0 comments on commit 7eae3a6

Please sign in to comment.