-
Notifications
You must be signed in to change notification settings - Fork 0
/
GettingStarted.txt
22 lines (15 loc) · 3.39 KB
/
GettingStarted.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
-- Getting Started --
This template has been created to get you off the ground running with a lot of resources that you need upfront. You'll notice that both the iOS and Android projects include a Splash Screen with the App Logo and material design colors (see below for more information on Material Design). You can quickly swap out the included image assets for your own images. To quickly generate image assets for your project take a 1536px x 1536px image to https://makeappicon.com/, there you can generate all of the images you need. For more help with Prism check out the Sample Applications at https://github.com/PrismLibrary/Prism-Samples-Forms or sign up for the Slack Channel https://prismslack.herokuapp.com/.
Note:
iOS: The Splash Screen icon uses the Icon-App-76x76 renamed to AppIcon
Android: The Splash Screen icon uses the mipmap-xxxhdpi/ic_launcher copied and renamed to drawable/launchscreen_icon
-- MFractor Support --
If you're developing in Visual Studio for Mac, be sure to check out MFractor. This template includes the NuGet MFractor Config for the QuickStart Templates. This will tune MFractor's tooling to provide you the best user experience while using Prism and the QuickStart Templates. Note that you can always add a local MFractor configuration to override any of the settings from the NuGet config. For more information be sure to check out https://www.mfractor.com/.
-- Localization --
This template comes default with Localization support. All of the helper classes you need have already been configured for you. To add support for additional languages you simply need to add additional Resource files. For example to support Spanish add a file named `Resource.es.resx` to the Resx directory. you should open the csproj file in a text editor and remove anything that the IDE has put in for this resource. You should find an ItemGroup labeled 'Localization'. There is already a Compile Update element ready for you that simply needs to be un-commented. For any additional languages follow the example format for the Spanish resource file.
-- Material Design --
This template also comes setup with support for Material Design. You will see the default colors for this template are set in the 'App.xaml'. There are a number of resources out there to help you choose the right colors for your app. One such resource can be found at https://material.io/color.
You will also notice that a global style has been set in 'App.xaml' to use the color pallet for the NavigationPage's NavigationBar colors. You updating your design colors will automatically adjust these colors without the need for defining any custom NavigationPage.
-- CI Builds --
This template makes it easy to handle App Secrets and Build defined Environments. Your template may include several defined variables already. This works with a two step process to make it easy on both build hosts (i.e. VSTS or AppCenter), as well as in your development environment. Note that this project comes with a .gitignore that will ignore both the secrets.json and Secrets.cs files to ensure you do not accidentally check in any secrets used during development.
These powerful DevOps tools are included from the Mobile.BuildTools package installed in your projects. For more information on how to configure your build server, or introduce any customizations for your project be sure to check out the ReadMe at https://github.com/dansiegel/Mobile.BuildTools