Skip to content

Commit

Permalink
Merge pull request #353 from dansiegel/dev/ds/package-readme
Browse files Browse the repository at this point in the history
Updating ReadMe's
  • Loading branch information
dansiegel authored Dec 22, 2024
2 parents 9e5b80d + ee69868 commit a42f662
Show file tree
Hide file tree
Showing 4 changed files with 67 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/Mobile.BuildTools.AppManifests/ReadMe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Mobile.BuildTools.AppManifests

The Mobile.BuildTools.AppManifests package provides support for managing your application manifests in your mobile applications. This package is designed to work with any mobile application project type including .NET MAUI, .NET Mobile, Uno Platform and Avalonia applications. This package assists you in transforming your application manifests at build time to ensure that you have better support in development and CI/CD with the ability to transform your application manifests based on your build configuration and environment. This is particularly useful in situations where you might need to include Client Ids that need to be changed between Development, Staging and Production environments.
58 changes: 58 additions & 0 deletions src/Mobile.BuildTools.AppSettings/ReadMe.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,61 @@
# Mobile.BuildTools.AppSettings

The Mobile.BuildTools.AppSettings is a re-invented implementation of the Classic Mobile.BuildTools that was originally generated as part of the Mobile.BuildTools project. This new implementation is significantly more powerful with an improved ability to control properties in Cross Compiled projects like those found in .NET MAUI and Uno Platform projects. This new implementation also provides an improved ability to bring in proeprties based on Prefixes and allows fuzzy matching for Configurations.

## Configuration

Be sure to add a `buildtools.json` to your solution root directory.

```json
{
"$schema": "https://mobilebuildtools.com/schemas/v2/buildtools.schema.json",
"appSettings": {
"YourProjectName": [
{
"className": "AppSettings",
"properties": [
{
"name": "PropertyName",
"type": "String",
},
{
"name": "SomeOtherProperty",
"type": "String",
"default": "Hello World"
}
]
}
]
},
"environment": {
"defaults": {
"SomeOtherProperty": "Hello Default Value"
},
"configuration": {
"Debug": {
"SomeOtherProperty": "Hello Debug Value"
},
"Android": {
"SomeOtherProperty": "Hello Android Value"
},
"iOS_Debug": {
"SomeOtherProperty": "Hello iOS Debug Value"
}
}
}
}
```

As shown you can provide defaults either on the property or in the environment configuration in your buildtools.json. Additionally you can provide values in an appsettings.json file which can be anywhere between your project and your solution.
```json
{
"PropertyName": "Hello World"
}
```

You can also provide values in an appsettings.Debug.json file which can be anywhere between your project and your solution.
```json
{
"PropertyName": "Hello Debug World"
}
```
3 changes: 3 additions & 0 deletions src/Mobile.BuildTools.Configuration/ReadMe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Mobile.BuildTools.Configuration

This package provides support for AppConfiguration that uses the classic app.config format to allow compile time or runtime configuration of your application. When using the app.config format this allows you to update your configuration at runtime without needing to recompile your application empowering scenarios where you may want to swap between Production and Stage environments in a live application. This is particularly useful in testing live applications where you may want to validate backend changes will not adversly affect your users.
3 changes: 3 additions & 0 deletions src/Mobile.BuildTools.Images/ReadMe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Mobile.BuildTools.Images

This package provides support for image management in your mobile applications. This package is designed to work with any mobile application project type including .NET MAUI, .NET Mobile, Uno Platform and Avalonia applications. Unlike Resizetizer, the Mobile.BuildTools Images package is designed to be significantly more flexible with providing image overlays and json configurations that are much more natural for developers with full intellisense support.

0 comments on commit a42f662

Please sign in to comment.