Skip to content

Commit 105b2d6

Browse files
conceptdevconceptdev
committed
update readmes
1 parent 61ae448 commit 105b2d6

File tree

17 files changed

+146
-123
lines changed

17 files changed

+146
-123
lines changed

‎AccelerometerPlay/README.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,16 @@ urlFragment: accelerometerplay
1212

1313
This sample demonstrates usage of the accelerometer to animate
1414
balls rolling on a wooden table.
15+
16+
![Screenshot of game with balls rolling on wooden surface](Screenshots/accelerometerplay.png)
17+
18+
## Prerequisites
19+
20+
- [Visual Studio](https://visualstudio.microsoft.com/) on Mac or Windows.
21+
- _Mobile Development with .NET (Xamarin)_ workload installed.
22+
- Android SDK installed (Visual Studio installer will do this for you).
23+
24+
## Running the sample
25+
26+
1. Open the solution file (**.sln**) in Visual Studio.
27+
1. Use the **Run** button or menu to start the app.

‎AccessoryViews/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ products:
88
- xamarin
99
urlFragment: accessoryviews
1010
---
11-
# AccessoryViews
11+
# Xamarin.Android AccessoryViews
1212

13-
This sample is part of the Android ListViews and Adapters series.
13+
This sample is part of the Android ListViews and Adapters [documentation](https://docs.microsoft.com/xamarin/android/user-interface/layouts/list-view/).

‎ActionBarPullToRefresh/README.md‎

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,18 @@ A binding library for https://github.com/chrisbanes/ActionBar-PullToRefresh.
55

66
To get javadoc so that the binding dll can get method parameter names:
77

8-
git clone above.
9-
cd ActionBar-PullToRefresh
10-
mvn clean verify javadoc:aggregate-jar
8+
```cmd
9+
git clone above.
10+
cd ActionBar-PullToRefresh
11+
mvn clean verify javadoc:aggregate-jar
12+
```
1113

1214
If you need to update library project zip:
1315

14-
cd library
15-
android update project -p .
16-
ant debug
17-
zip -r ActionBar-PullToRefresh.zip bin/classes.jar bin/AndroidManifest.xml res
18-
mv ActionBar-PullToRefresh.zip ActionBarPullToRefresh/Jars
19-
16+
```cmd
17+
cd library
18+
android update project -p .
19+
ant debug
20+
zip -r ActionBar-PullToRefresh.zip bin/classes.jar bin/AndroidManifest.xml res
21+
mv ActionBar-PullToRefresh.zip ActionBarPullToRefresh/Jars
22+
```

‎ActionBarViewPager/Readme.md‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,7 @@ products:
88
- xamarin
99
urlFragment: actionbarviewpager
1010
---
11-
# HelloSwipeViewWithTabs
12-
13-
Author: Richard Lander -- [email protected]
14-
15-
License: Apache 2
11+
# Xamarin.Android HelloSwipeViewWithTabs
1612

1713
This sample app demonstrates how to use ViewPager and ActionBar
1814
together. ViewPager provides a "swiping view" and ActionBar provides
@@ -22,6 +18,8 @@ These two classes provide a very nice user experience together, but do
2218
not provide an intuitive approach to integration. This sample
2319
demonstrates how.
2420

21+
![Android app with tabs](Screenshots/01.png)
22+
2523
There are two primary integration challenges:
2624

2725
- ActionBar and Viewpager come in different versions of the Android SDK and require special handling to work together.
@@ -40,9 +38,13 @@ and related classes whereas Viewpager works with
4038
trick is to change your Activity to derive from
4139
[FragmentActivity](http://developer.android.com/reference/android/support/v4/app/FragmentActivity.html),
4240
which satisfies both the regular and 'Support' API worlds.
43-
41+
4442
The sample provides "shape" classes that satisfy the API requirements
4543
of ViewPager, and then uses lambdas to provide the required
4644
implementation. This approach ends up being quite nice, since the
4745
implementation can be written inline within the Activity without
48-
hiding it within separate classes. That's not a requirement, however.
46+
hiding it within separate classes. That's not a requirement, however.
47+
48+
## License
49+
50+
Apache 2

‎ActivityLifecycle/README.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
11
---
22
name: Xamarin.Android - Android Activity Lifecycle
3-
description: This sample app accompanies the article, Walkthrough - Saving the Activity State. ![](Screenshots/example-screenshot.png)
3+
description: This sample app accompanies Saving the Activity State documentation.
44
page_type: sample
55
languages:
66
- csharp
77
products:
88
- xamarin
99
urlFragment: activitylifecycle
1010
---
11-
# Android Activity Lifecycle
11+
# Xamarin.Android activity lifecycle
1212

13-
This sample app accompanies the article,
14-
[Walkthrough - Saving the Activity State](http://developer.xamarin.com/guides/android/application_fundamentals/activity_lifecycle/saving_state_walkthrough).
13+
This sample app accompanies the article,
14+
[Walkthrough - Saving the Activity State](https://docs.microsoft.com/en-us/xamarin/android/app-fundamentals/activity-lifecycle/saving-state).
1515

16-
17-
[ ![](Screenshots/example-screenshot-sml.png)](Screenshots/example-screenshot.png)
16+
[![Two phones showing screen in portrait and landscape](Screenshots/example-screenshot-sml.png)](Screenshots/example-screenshot.png)

‎AdvancedAppLifecycleDemos/README.md‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,11 @@ products:
88
- xamarin
99
urlFragment: advancedapplifecycledemos
1010
---
11-
# ActivityLifecycle Demos
12-
Four sample projects that cover advanced activity and application lifecycle scenarios in
13-
Android:
14-
* ActivityLifecycle - Handling the activity lifecycle including rotation and subscribing to external events
15-
* AppInitialization - Showing a loading screen while the app initializes
16-
* HandlingCrashes - Gracefully handling app crashes, waiting for app initializing and launching specific activities after crashes
17-
* InitializingAppAndServices - Handling multiple asynchronous initializations
11+
# Xamarin.Android ActivityLifecycle Demos
1812

19-
## Authors
20-
Bryan Costanich
13+
Four sample projects that cover advanced activity and application lifecycle scenarios in Android:
14+
15+
- ActivityLifecycle - Handling the activity lifecycle including rotation and subscribing to external events
16+
- AppInitialization - Showing a loading screen while the app initializes
17+
- HandlingCrashes - Gracefully handling app crashes, waiting for app initializing and launching specific activities after crashes
18+
- InitializingAppAndServices - Handling multiple asynchronous initializations

‎AdvancedImmersiveMode/README.md‎

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
11
---
22
name: Xamarin.Android - Advanced Immersive Mode
3-
description: Android 4.4 introduces a way for you to provide a more immersive screen experience in your app, by letting users show or hide the status bar and...
3+
description: "Android 4.4 introduces a way for you to provide a more immersive screen experience in your app: show/hide the status bar #androidkitkat"
44
page_type: sample
55
languages:
66
- csharp
77
products:
88
- xamarin
99
urlFragment: advancedimmersivemode
1010
---
11-
# Advanced Immersive Mode
12-
Android 4.4 introduces a way for you to provide a more immersive
13-
screen experience in your app, by letting users show or hide
11+
# Xamarin.Android Advanced Immersive Mode
12+
13+
Android 4.4 introduces a way for you to provide a more immersive
14+
screen experience in your app, by letting users show or hide
1415
the status bar and navigation bar with a swipe.
1516

16-
This sample demonstrates how this feature interacts with some
17-
of the other UI flags related to full-screen apps. The sample
18-
also shows how to implement a "sticky" mode, which re-hides
19-
the bars a few seconds after the user swipes them back in.
17+
This sample demonstrates how this feature interacts with some
18+
of the other UI flags related to full-screen apps. The sample
19+
also shows how to implement a "sticky" mode, which re-hides
20+
the bars a few seconds after the user swipes them back in.
21+
22+
![Android app without status bar](Screenshots/AdvancedImmersiveMode1.png)

‎android-support/ViewModel/README.md‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,23 @@
11
---
22
name: Xamarin.Android - ViewModel Sample
3-
description: This sample demonstrates usage of ViewModel and LifeCycle Architecture Components library by Android. Build Requirements Using this sample requires...
3+
description: "This sample demonstrates usage of ViewModel and LifeCycle Architecture Components library by Android #androidoreo"
44
page_type: sample
55
languages:
66
- csharp
77
products:
88
- xamarin
99
urlFragment: android-support-viewmodel
1010
---
11-
# ViewModel Sample
11+
# Xamarin.Android ViewModel Sample
1212

1313
This sample demonstrates usage of ViewModel and LifeCycle [Architecture Components](https://developer.android.com/topic/libraries/architecture/index.html) library by Android.
1414

15+
![ViewModel Sample application screenshot](Screenshots/Home.png "ViewModel Sample application screenshot")
1516

1617
## Build Requirements
1718

1819
Using this sample requires the Android 8.1 (API 27) and the Xamarin.Android 8.2 or higher.
1920

21+
## License
2022

21-
![ViewModel Sample application screenshot](Screenshots/Home.png "ViewModel Sample application screenshot")
22-
23-
## Authors
24-
25-
Copyright (c) 2018 The Android Open Source Project, Inc.
26-
27-
Ported to Xamarin.Android by Gonzalo Martin
23+
Original copyright (c) 2018 The Android Open Source Project, Inc.

‎android5.0/ActivitySceneTransitionBasic/README.md‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,28 @@
11
---
22
name: Xamarin.Android - ActivitySceneTransitionBasic
3-
description: This sample demonstrates how to the use Activity scene transitions when transitioning from one activity to another. Uses a combination of moveImage...
3+
description: "Demonstrates how to the use Activity scene transitions when transitioning from one activity to another #androidlollipop"
44
page_type: sample
55
languages:
66
- csharp
77
products:
88
- xamarin
99
urlFragment: android50-activityscenetransitionbasic
1010
---
11-
# ActivitySceneTransitionBasic
11+
# Xamarin.Android ActivitySceneTransitionBasic
12+
1213
This sample demonstrates how to the use Activity scene transitions when transitioning from one activity to another. Uses a combination of moveImage and changeBounds to nicely transition from a grid of images to an activity with a large image and detail text.
1314

1415
## Instructions
16+
1517
* Touch each photo to activate a transition to a details page for each one.
1618
* Hitting the back button will activate a transition back to the grid of photos.
1719

1820
## Build Requirements
21+
1922
This sample requires Xamarin.Android 4.17 or later and an Android L or later device.
2023

2124
![ActivitySceneTransitionBasic application screenshot](Screenshots/Detailed View.png "ActivitySceneTransitionBasic application screenshot")
2225

2326
## Author
24-
Copyright (c) 2005-2008, The Android Open Source Project
25-
Ported to Xamarin.Android by Sean Pearl
27+
28+
Original copyright (c) 2005-2008, The Android Open Source Project

‎android5.0/AppRestrictionSchema/README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Xamarin.Android - App Restriction Schema
3-
description: This sample shows a basic demonstration of using a profile owner to set app restrictions in Android. This is to used alongside...
3+
description: "This sample shows a basic demonstration of using a profile owner to set app restrictions in Android #androidlollipop"
44
page_type: sample
55
languages:
66
- csharp
@@ -12,19 +12,19 @@ urlFragment: android50-apprestrictionschema
1212

1313
This sample shows a basic demonstration of using a profile owner to set app restrictions in Android. This is to used alongside AppRestrictionEnforcer, which serves as a profile owner for this.
1414

15+
![App Restriction Schema application screenshot](Screenshots/Not Restricted.png "App Restriction Schema application screenshot")
16+
1517
## Instructions
1618

17-
* Run the project
18-
* Pressing the button on this fragment pops up a simple Toast message. The button is enabled or disabled according to the restrictions set by device/profile owner. You can use the AppRestrictionEnforcer sample as a profile owner for this.
19+
- Run the project
20+
- Pressing the button on this fragment pops up a simple Toast message. The button is enabled or disabled according to the restrictions set by device/profile owner. You can use the AppRestrictionEnforcer sample as a profile owner for this.
1921

2022
## Build Requirements
21-
* Xamarin Studio 5.3+
22-
* Xamarin Android 4.20+
23-
* Android SDK (Lollipop)
2423

25-
![App Restriction Schema application screenshot](Screenshots/Not Restricted.png "App Restriction Schema application screenshot")
24+
- Xamarin Studio 5.3+
25+
- Xamarin Android 4.20+
26+
- Android SDK (Lollipop)
2627

27-
## Author
28-
Copyright 2014 The Android Open Source Project
28+
## License
2929

30-
Ported to Xamarin.Android by John Pilczak
30+
Original copyright 2014 The Android Open Source Project

0 commit comments

Comments
 (0)