From 6aa8419c49cfb8d8e974f4e01b0a22fa8a892fc5 Mon Sep 17 00:00:00 2001
From: Daniel McNab <36049421+DJMcNab@users.noreply.github.com>
Date: Wed, 29 May 2024 16:09:54 +0100
Subject: [PATCH 1/3] Add a major note about the outdated versioning
---
README.md | 23 ++++++++++++++++++-----
1 file changed, 18 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index 83ca372a..4d7378dd 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,18 @@
+> [!INFO]
+> Masonry has been moved into the [Xilem](https://github.com/linebender/xilem/tree/main/masonry) repository.
+> It can be found in the `masonry` folder at the root in that repository, which in turn can be found at .
+> This repository may be useful for exploring the history of Masonry.
+>
+> The version of Masonry in that repository is now also [published](https://crates.io/crates/masonry) on crates.io.
+
## Masonry
+> [!WARNING]
+> **This README is outdated.**
+>
+> See the info box above for more details.
+> The previous README is included for historical reference.
+
Masonry is a framework that aims to provide the foundation for Rust GUI libraries.
Masonry gives you a platform to create windows (using [Glazier](https://github.com/linebender/glazier) as a backend) each with a tree of widgets. It also gives you tools to inspect that widget tree at runtime, write unit tests on it, and generally have an easier time debugging and maintaining your app.
@@ -8,7 +21,7 @@ The framework is not opinionated about what your user-facing abstraction will be
This project was originally a fork of [Druid](https://github.com/linebender/druid) that emerged from discussions I had with Raph Levien and Colin Rofls about what it would look like to turn Druid into a foundational library.
-## Installing
+
## Example
@@ -96,7 +110,6 @@ This simplicity makes Masonry somewhat painful if you want to use it to actually
(Well, in theory. The first stress-test will be porting [Panoramix](https://github.com/PoignardAzur/panoramix), a React-style GUI in Rust, to Masonry.)
-
## Unit tests
Masonry is designed to make unit tests easy to write, as if the test function were a mouse-and-keyboard user. Tests look like this:
@@ -136,9 +149,9 @@ fn some_test_with_a_button() {
}
```
-## Contributing
+
## Roadmap
From c5f65e6aab0f911e65cba457f7b49e7c4ff33f62 Mon Sep 17 00:00:00 2001
From: Daniel McNab <36049421+DJMcNab@users.noreply.github.com>
Date: Wed, 29 May 2024 16:11:15 +0100
Subject: [PATCH 2/3] Use correct alert kind name
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 4d7378dd..99097e71 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-> [!INFO]
+> [!NOTE]
> Masonry has been moved into the [Xilem](https://github.com/linebender/xilem/tree/main/masonry) repository.
> It can be found in the `masonry` folder at the root in that repository, which in turn can be found at .
> This repository may be useful for exploring the history of Masonry.
From 89c2d9e4603f94167801aff2d488f57973711d2a Mon Sep 17 00:00:00 2001
From: Daniel McNab <36049421+DJMcNab@users.noreply.github.com>
Date: Wed, 29 May 2024 16:14:30 +0100
Subject: [PATCH 3/3] Use different names
---
README.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 99097e71..5321a8ef 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-> [!NOTE]
+> [!Important]
> Masonry has been moved into the [Xilem](https://github.com/linebender/xilem/tree/main/masonry) repository.
> It can be found in the `masonry` folder at the root in that repository, which in turn can be found at .
> This repository may be useful for exploring the history of Masonry.
@@ -7,7 +7,7 @@
## Masonry
-> [!WARNING]
+> [!Caution]
> **This README is outdated.**
>
> See the info box above for more details.