Skip to content

Commit 326c4ba

Browse files
authored
landing page, install, and quickstart (#508)
* landing page, install, and quickstart
1 parent 20935c7 commit 326c4ba

File tree

4 files changed

+48
-55
lines changed

4 files changed

+48
-55
lines changed

source/dotnet.txt

Lines changed: 38 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,31 @@ platforms to access data stored in local {+realms+} and
1212
interact with {+backend+} services like Functions, MongoDB Data Access,
1313
and authentication.
1414

15-
For more information about specific version support for .NET, UWP, and
16-
Xamarin, see our :ref:`compatibility chart <dotnet-compatibility>`.
15+
.. _dotnet_supported-platforms:
1716

18-
.. note::
17+
Supported Platforms
18+
-------------------
19+
Realm supports the following platforms for developing Realm apps for iOS and
20+
Android devices:
1921

20-
When building
21-
for platforms with Xamarin, you can use either native UI or
22-
`Xamarin Forms
23-
<https://docs.microsoft.com/en-us/xamarin/xamarin-forms/>`__.
22+
- Xamarin.iOS for iOS 9 or later, using native UI or Xamarin Forms
23+
- Xamarin.Android for API level 16 or later, using native UI or Xamarin Forms
24+
- Xamarin.Mac for macOS 10.11 or later, using nativeUI or Xamarin Forms
25+
- .NET Framework 4.6.1 or later for Windows 8.1 or later
26+
- Universal Windows Platform applications using .NET Standard 2.0 or later (Fall Creators Update)
27+
- .NET Core 2.0 or later on the following:
28+
29+
- Ubuntu 16.04 or later
30+
- Debian 8 or later
31+
- RHEL 7.1 or later
32+
- macOS 10.11 or later
33+
- Windows 8.1 or later
34+
35+
You can use the following development environments to build Realm apps with
36+
the .NET SDK:
37+
38+
- Visual Studio 2015 Update 2 or higher for Windows
39+
- Visual Studio for Mac 7.0 or higher
2440

2541
Installation
2642
------------
@@ -29,38 +45,36 @@ To learn how to add the {+service+} .NET SDK library as a dependency
2945
to your application, see :ref:`Install Realm for .NET
3046
<dotnet-install>`.
3147

32-
The Realm Data Model
33-
--------------------
48+
Realm Data Models
49+
-----------------
3450

3551
You can store a wide variety of data within {+realms+} stored on your
36-
device. With :term:`{+sync+}`, you can share updates to that data across
37-
client devices and {+atlas+}.
52+
device, and if you enable :term:`{+sync+}`, updates to that data are available
53+
across multiple client devices. Data models are classes defined in your
54+
code and in {+realm+} schemas.
3855

3956
For information about the structure of data you can store in {+realms+},
4057
see :ref:`Realms <dotnet-realms>`, :ref:`Objects
4158
<dotnet-realm-objects>`, and :ref:`Relationships
4259
<dotnet-client-relationships>`.
4360

44-
To learn about the results returned from {+realm+} queries, see
45-
:ref:`Collections <android-client-collections>`.
46-
47-
Work with Realm Database
48-
------------------------
61+
Work with a Realm Database
62+
--------------------------
4963

50-
Once you have defined a data model for your application, you
51-
need to be able to :ref:`write <dotnet-realm-database-writes>` and
52-
:ref:`read <dotnet-realm-database-reads>` pieces of data to and from
64+
Once you have defined the data model(s) for your application, you
65+
can :ref:`write <dotnet-realm-database-writes>` and
66+
:ref:`read <dotnet-realm-database-reads>` data to and from
5367
your {+realm+}s.
5468

5569
To learn how to query for data in local {+realms+}, see
5670
:ref:`Query Engine <dotnet-client-query-engine>`.
5771

58-
For advice on how to safely interact with {+client-database+} across
59-
threads in an application, see :ref:`Threading
60-
<dotnet-client-threading>`.
72+
To learn about the results returned from {+realm+} queries, see
73+
:ref:`Collections <dotnet-client-collections>`.
6174

62-
For information about how to react to changes in {+realm+} data, see
63-
:ref:`Notifications <dotnet-client-notifications>`.
75+
Mobile application development can be complicated by threading. To learn
76+
how to work with {+backend-short+} across threads in your application,
77+
see :ref:`Threading <dotnet-client-threading>`.
6478

6579
Work with MongoDB Realm
6680
-----------------------

source/dotnet/install.txt

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,26 +19,23 @@ Overview
1919
for the .NET, `UWP
2020
<https://docs.microsoft.com/en-us/windows/uwp/get-started/>`__,
2121
and `Xamarin <https://dotnet.microsoft.com/apps/xamarin>`__
22-
ecosystems. When building for platforms with Xamarin, you
23-
can use either native UI or `Xamarin Forms
24-
<https://docs.microsoft.com/en-us/xamarin/xamarin-forms/>`__.
22+
ecosystems.
2523

2624
For more information about specific version support for .NET, UWP, and
27-
Xamarin, see our :ref:`compatibility chart <dotnet-compatibility>`.
25+
Xamarin, see :ref:`Supported Platforms <dotnet_supported-platforms>`.
2826

2927
Prerequisites
3028
-------------
3129

32-
Before getting started, ensure your development environment
33-
meets the following prerequisites:
30+
Before getting started, ensure you have installed Visual Studio:
3431

3532
- `Visual Studio <https://visualstudio.microsoft.com/downloads/>`__ 2015 Update 2 or later.
3633
- `Visual Studio for Mac <https://visualstudio.microsoft.com/vs/mac/>`__ 7.0 or later.
3734

3835
Installation
3936
------------
4037

41-
Follow these steps to add the {+service+}.NET SDK to your project.
38+
Follow these steps to add the {+service+} .NET SDK to your project.
4239

4340
.. tabs::
4441

source/dotnet/quick-start.txt

Lines changed: 5 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -21,29 +21,11 @@ integrated into your .NET app. Before you begin, ensure you have:
2121
- :ref:`Created a {+app+} <create-a-realm-app>`
2222
- :ref:`Enabled {+sync+} <enable-sync>`
2323

24-
Supported Platforms
25-
-------------------
26-
Realm supports the following platforms for developing Realm apps for iOS and
27-
Android devices:
28-
29-
- Visual Studio 2019
30-
- Xamarin.iOS for iOS 8 or later, using native UI or Xamarin Forms
31-
- Xamarin.Android for API level 16 or later, using native UI or Xamarin Forms
32-
- Xamarin.Mac for macOS 10.11 or later, using nativeUI or Xamarin Forms
33-
- .NET Framework 4.6.1 or later for Windows 8.1 or later
34-
- Universal Windows Platform applications using .NET Standard 2.0 or later (Fall Creators Update)
35-
- .NET Core 2.0 or later on the following:
36-
37-
- Ubuntu 16.04 or later
38-
- Debian 8 or later
39-
- RHEL 7.1 or later
40-
- macOS 10.11 or later
41-
- Windows 8.1 or later
42-
43-
And supports the following development environments:
44-
45-
- Visual Studio 2015 Update 2 or higher for Windows
46-
- Visual Studio for Mac 7.0 or higher
24+
.. note::
25+
26+
See :ref:`Supported Platforms <dotnet_supported-platforms>` for the list of
27+
platforms that Realm supports.
28+
4729

4830
Import Realm
4931
------------

source/includes/steps-install-dotnet-vs-mac.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ content: |
2424
:lightbox:
2525
2626
---
27-
title: Add the Realm Weaver to FodyWeavers.xml
27+
title: (Optional) Add the Realm Weaver to FodyWeavers.xml
2828
ref: add-realm-weaver
2929
content: |
3030

0 commit comments

Comments
 (0)