Skip to content

Commit 2b7927c

Browse files
committed
[General] Update READMEs
1 parent aeec587 commit 2b7927c

File tree

8 files changed

+285
-212
lines changed

8 files changed

+285
-212
lines changed

README.md

Lines changed: 53 additions & 207 deletions
Large diffs are not rendered by default.

README.old.md

Lines changed: 207 additions & 0 deletions
Large diffs are not rendered by default.

sources/editor/Stride.Assets.Editor/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This project is the main project for the assets in the editor.
66

77
* It can references any Stride libraries, as long as their are cross-platform.
88
* It should be platform-agnostic as well as UI-agnostic.
9-
In other words, no dependencies on platform (e.g. Windows), or UI library (e.g. Avalonia, WPF) is allowed.
9+
In other words, no dependencies on platform (e.g. Windows), or UI library (e.g. Avalonia, WPF) are allowed.
1010
* It will likely only reference `Stride.Assets.Presentation`.
1111

1212
## Implementations

sources/editor/Stride.Assets.Presentation/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This project is the main project for the view models of Stride assets in an appl
66

77
* It can references any Stride libraries, as long as their are cross-platform.
88
* It should be platform-agnostic as well as UI-agnostic.
9-
In other words, no dependencies on platform (e.g. Windows), or UI library (e.g. Avalonia, WPF) is allowed.
9+
In other words, no dependencies on platform (e.g. Windows), or UI library (e.g. Avalonia, WPF) are allowed.
1010
* It will likely only reference `Stride.Assets` and `Stride.Core.Assets.Presentation`.
1111

1212
## Implementations

sources/editor/Stride.Core.Assets.Editor/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This project is the base project for the core assets in the editor.
66

77
* It can only references *Core.Assets* libraries.
88
* It should be platform-agnostic as well as UI-agnostic.
9-
In other words, no dependencies on platform (e.g. Windows), or UI library (e.g. Avalonia, WPF) is allowed.
9+
In other words, no dependencies on platform (e.g. Windows), or UI library (e.g. Avalonia, WPF) are allowed.
1010
* It will likely only reference `Stride.Core.Assets.Presentation`.
1111

1212
## Implementations

sources/editor/Stride.Core.Assets.Presentation/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This project is the base project for the view models of assets in an application
66

77
* It can only references *Core.Assets* libraries.
88
* It should be platform-agnostic as well as UI-agnostic.
9-
In other words, no dependencies on platform (e.g. Windows), or UI library (e.g. Avalonia, WPF) is allowed.
9+
In other words, no dependencies on platform (e.g. Windows), or UI library (e.g. Avalonia, WPF) are allowed.
1010
* It will likely only reference `Stride.Core.Assets.Quantum` and `Stride.Core.Presentation`.
1111

1212
## Implementations
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Stride.Core.Presentation.Quantum
2+
3+
This project adds capabilities to the `Stride.Core.Quantum` library to allow its use in a MVVM context.
4+
5+
## Depencencies
6+
7+
* It can only references *Core* libraries.
8+
* It should be platform-agnostic as well as UI-agnostic.
9+
In other words, no dependencies on platform (e.g. Windows), or UI library (e.g. Avalonia, WPF) are allowed.
10+
* It will likely only reference `Stride.Core.Quantum` and `Stride.Core.Presentation`.
11+
12+
## Implementations
13+
14+
`NodeViewModel` is here as well as interfaces for presenters (but usually not their implementation).
15+
16+
## Notes
17+
18+
* The goal is to be able to share that library with any application that wants to work with Stride core.
19+
* It can theoretically be used for another engine that would only be based on the core libraries.
20+
So it has no dependency on the Stride runtime.

sources/presentation/Stride.Core.Presentation/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This project is the base project for the view models in an application that uses
66

77
* It can only references *Core* libraries.
88
* It should be platform-agnostic as well as UI-agnostic.
9-
In other words, no dependencies on platform (e.g. Windows), or UI library (e.g. Avalonia, WPF) is allowed.
9+
In other words, no dependencies on platform (e.g. Windows), or UI library (e.g. Avalonia, WPF) are allowed.
1010
* It will likely only reference `Stride.Core.Design`.
1111

1212
## Implementations

0 commit comments

Comments
 (0)