[readme] tweaks
This commit is contained in:
Родитель
8437981fa3
Коммит
44417f7efa
51
README.md
51
README.md
|
@ -1,53 +1,6 @@
|
||||||
---
|
# Surface Duo Flutter samples
|
||||||
page_type: sample
|
|
||||||
languages:
|
|
||||||
- csharp
|
|
||||||
products:
|
|
||||||
- dotnet
|
|
||||||
description: "Add 150 character max description"
|
|
||||||
urlFragment: "update-this-to-unique-url-stub"
|
|
||||||
---
|
|
||||||
|
|
||||||
# Official Microsoft Sample
|
This repo contains Flutter samples that incorporate dual-screen enhancements for the Microsoft Surface Duo.
|
||||||
|
|
||||||
<!--
|
|
||||||
Guidelines on README format: https://review.docs.microsoft.com/help/onboard/admin/samples/concepts/readme-template?branch=master
|
|
||||||
|
|
||||||
Guidance on onboarding samples to docs.microsoft.com/samples: https://review.docs.microsoft.com/help/onboard/admin/samples/process/onboarding?branch=master
|
|
||||||
|
|
||||||
Taxonomies for products and languages: https://review.docs.microsoft.com/new-hope/information-architecture/metadata/taxonomies?branch=master
|
|
||||||
-->
|
|
||||||
|
|
||||||
Give a short description for your sample here. What does it do and why is it important?
|
|
||||||
|
|
||||||
## Contents
|
|
||||||
|
|
||||||
Outline the file contents of the repository. It helps users navigate the codebase, build configuration and any related assets.
|
|
||||||
|
|
||||||
| File/folder | Description |
|
|
||||||
|-------------------|--------------------------------------------|
|
|
||||||
| `src` | Sample source code. |
|
|
||||||
| `.gitignore` | Define what to ignore at commit time. |
|
|
||||||
| `CHANGELOG.md` | List of changes to the sample. |
|
|
||||||
| `CONTRIBUTING.md` | Guidelines for contributing to the sample. |
|
|
||||||
| `README.md` | This README file. |
|
|
||||||
| `LICENSE` | The license for the sample. |
|
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
Outline the required components and tools that a user might need to have on their machine in order to run the sample. This can be anything from frameworks, SDKs, OS versions or IDE releases.
|
|
||||||
|
|
||||||
## Setup
|
|
||||||
|
|
||||||
Explain how to prepare the sample once the user clones or downloads the repository. The section should outline every step necessary to install dependencies and set up any settings (for example, API keys and output folders).
|
|
||||||
|
|
||||||
## Running the sample
|
|
||||||
|
|
||||||
Outline step-by-step instructions to execute the sample and see its output. Include steps for executing the sample from the IDE, starting specific services in the Azure portal or anything related to the overall launch of the code.
|
|
||||||
|
|
||||||
## Key concepts
|
|
||||||
|
|
||||||
Provide users with more context on the tools and services used in the sample. Explain some of the code that is being used and how services interact with each other.
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
This is the basic starter application modified to use the Surface Duo SDK and surface the information in the Flutter application.
|
This is the basic starter application modified to use the Surface Duo SDK and surface the information in the Flutter application.
|
||||||
|
|
||||||
## Getting Started
|
## Get Started
|
||||||
|
|
||||||
For details about this application check out the blog post on the [Surface Duo Developer Blog](https://devblogs.microsoft.com/surface-duo/get-started-with-flutter-on-surface-duo/)
|
For details about this application check out the blog post on the [Surface Duo Developer Blog](https://devblogs.microsoft.com/surface-duo/get-started-with-flutter-on-surface-duo/)
|
||||||
|
|
||||||
|
@ -11,6 +11,8 @@ A few resources to get you started if this is your first Flutter project:
|
||||||
- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab)
|
- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab)
|
||||||
- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook)
|
- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook)
|
||||||
|
|
||||||
For help getting started with Flutter, view our
|
For help getting started with Flutter, view the Flutter
|
||||||
[online documentation](https://flutter.dev/docs), which offers tutorials,
|
[online documentation](https://flutter.dev/docs), which offers tutorials,
|
||||||
samples, guidance on mobile development, and a full API reference.
|
samples, guidance on mobile development, and a full API reference.
|
||||||
|
|
||||||
|
Visit the [Microsoft dual-screen documentation](http://docs.microsoft.com/dual-screen) for more information on the Surface Duo and the underlying Android helper libraries for dual-screen development.
|
||||||
|
|
Загрузка…
Ссылка в новой задаче