Skip to content

Commit

Permalink
Update documentation to reflect the discontinuation. (#2412)
Browse files Browse the repository at this point in the history
It has been almost two years since the last major Druid release of v0.8.
There have been a few minor additions and fixes since then and those
will be part of one final upcoming release.

However, it is time to make it even more clear that everyone's focus
should be concentrated on one of the more active Rust UI projects. For
the Linebender team that focus will be on
[Xilem](https://github.com/linebender/xilem).
  • Loading branch information
xStrom authored Oct 25, 2024
1 parent 7ecc790 commit 55e2dd8
Show file tree
Hide file tree
Showing 7 changed files with 53 additions and 46 deletions.
13 changes: 8 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# How to contribute
# UNMAINTAINED

As the Druid project has been discontinued, **we will not be accepting any more contributions**.

**IMPORTANT:** The Druid project is being discontinued. While we will still accept
all contributions, we'll prefer bug fixes and documentation improvements to new
features.
Please take a look at some of our other projects instead, especially the Druid successor [Xilem].

# How to contribute

If you still want to contribute, here are the guidelines you need to follow.
The following document reflects the state of contribution policy before the project was discontinued.

## Changelog

Expand Down Expand Up @@ -251,3 +253,4 @@ Finally, we [create a new Github release](https://docs.github.com/en/github/admi
[`cargo-edit`]: https://crates.io/crates/cargo-edit
[semver]: https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html
[git `pre-push` hook]: https://githooks.com
[Xilem]: https://github.com/linebender/xilem
52 changes: 20 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,41 +7,38 @@
[![license](https://img.shields.io/crates/l/druid)](https://github.com/linebender/druid/blob/master/LICENSE)
[![chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://xi.zulipchat.com)

Druid is an experimental Rust-native UI toolkit. Its main goal is to offer a
polished user experience. There are many factors to this goal, including
Druid was an experimental Rust-native UI toolkit. Its main goal was to offer a
polished user experience. There were many factors to this goal, including
performance, a rich palette of interactions (hence a widget library to support
them), and playing well with the native platform.
See the [goals section](#Goals) for more details.

We have been doing periodic releases of Druid on crates.io, but the API is still unstable. All changes are documented
We did periodic releases of Druid on crates.io. All changes were documented
in [the changelog](https://github.com/linebender/druid/blob/master/CHANGELOG.md).

For an overview of some key concepts, see the (work in progress) [Druid book].
For an overview of some key concepts, see the incomplete [Druid book].

## Project status

**The Druid project is being discontinued by the core developer team.**
**UNMAINTAINED**

New development effort is focused on [Xilem], which has a lot of fundamental changes to allow for
**The Druid project has been discontinued.**

New development effort moved on to [Xilem], which has a lot of fundamental changes to allow for
a wider variety of applications with better performance, but it also heavily inherits from Druid.
We see [Xilem] as the future of Druid.

Druid is reasonably usable for [some subset of applications](https://github.com/linebender/druid/issues/1360)
and has a significant testing history, which ensures some stability and correctness.
However we don't expect any major new features to be added to Druid. As such we don't recommend
However, there will not be any new features or bug fixes coming to Druid. As such we don't recommend
using Druid for brand new applications. If you insist, then at least make sure your application
doesn't require a feature that Druid doesn't have, e.g. accessibility or 3D support.

## Contributions

As the Druid project is being discontinued, we will still accept all contributions,
but we'll prefer bug fixes and documentation improvements to new features.

A very good place to ask questions and discuss development work is our [Zulip
chat instance], in the #druid-help and #druid channels, respectively.
As the Druid project has been discontinued, **we will not be accepting any more contributions**.

We gladly accept contributions via GitHub pull requests. Please see
[CONTRIBUTING.md] for more details.
Please take a look at some of our other projects instead, especially the Druid successor [Xilem].

## Example

Expand Down Expand Up @@ -83,22 +80,14 @@ Druid's existing functionality and widgets. Check [druid_widget_nursery](https:/

## Using Druid

An explicit goal of Druid is to be easy to build, so please open an issue if you
run into any difficulties. Druid is available on [crates.io] and should work as
a lone dependency (it re-exports all the parts of `druid-shell`, `piet`, and `kurbo`
that you'll need):
An explicit goal of Druid was to be easy to build.
Druid is available on [crates.io] and should work as a lone dependency
(it re-exports all the parts of `druid-shell`, `piet`, and `kurbo` that you'll need):

```toml
druid = "0.8.3"
```

Since Druid is currently in fast-evolving state, you might prefer to drink from
the firehose:

```toml
druid = { git = "https://github.com/linebender/druid.git" }
```

### Platform notes

#### Linux
Expand All @@ -119,9 +108,9 @@ You can try it out with `--features=x11`.

## Goals

Druid's goal is to make it easy to write and deploy high quality desktop
Druid's goal was to make it easy to write and deploy high quality desktop
applications with a smooth and polished user experience on all common
platforms. In order to achieve this we strive for a variety of things:
platforms. In order to achieve this we strived for a variety of things:

- Make it easy to build and package on all supported platforms.
- Implement abstractions to avoid platform specific quirks.
Expand All @@ -137,7 +126,7 @@ platforms. In order to achieve this we strive for a variety of things:

### Non-Goals

In order to fulfill those goals, we cannot support every use case. Luckily
In order to fulfill those goals, we couldn't support every use case. Luckily
the Rust community is working on a variety of different libraries with
different goals, so here are some of Druid's non-goals and possible
alternatives that can offer those capabilities:
Expand All @@ -147,8 +136,7 @@ alternatives that can offer those capabilities:
- Adhere to a specific architectural style such as Elm. ([Iced], [Relm])
- Support rendering to HTML when targeting the web. ([Iced], [Moxie])

Druid is just one of many ongoing [Rust-native GUI experiments]. If it
doesn't suit your use case, perhaps one of the others will!
Druid was just one of many ongoing [Rust-native GUI experiments].

## Concepts

Expand All @@ -159,7 +147,7 @@ The Druid toolkit uses `druid-shell` for a platform-abstracting application shel
events, converting them into a platform-agnostic representation, and calling a
user-provided handler with them.

While `druid-shell` is being developed with the Druid toolkit in mind, it is
While `druid-shell` was being developed with the Druid toolkit in mind, it was
intended to be general enough that it could be reused by other projects
interested in experimenting with Rust GUI. The `druid-shell` crate includes a
couple of [non-`druid` examples].
Expand Down Expand Up @@ -254,7 +242,7 @@ fn build_widget() -> impl Widget<u32> {

### layout

Druid's layout protocol is strongly inspired by [Flutter's box layout model].
Druid's layout protocol was strongly inspired by [Flutter's box layout model].
In Druid, widgets are passed a `BoxConstraint` that provides them a minimum and
maximum size for layout. Widgets are also responsible for computing appropriate
constraints for their children if applicable.
Expand Down
11 changes: 10 additions & 1 deletion docs/src/01_overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
# Druid

**Note:** Druid is being discontinued in favor of other projects based on the same general principles, such as [Xilem](https://github.com/linebender/xilem/).
**UNMAINTAINED**

**The Druid project has been discontinued.**

New development effort moved on to [Xilem], which has a lot of fundamental changes to allow for
a wider variety of applications with better performance, but it also heavily inherits from Druid.
We see [Xilem] as the future of Druid.

## Introduction

Druid is a framework for building simple graphical applications.

Expand Down Expand Up @@ -40,3 +48,4 @@ released version of Druid (v0.8).
[the `Data` trait]: ./03_data.md
[the `Widget` trait]: ./04_widget.md
[the `Lens` trait]: ./05_lens.md
[Xilem]: https://github.com/linebender/xilem
4 changes: 2 additions & 2 deletions docs/src/09_more_information.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ These three projects provide the basis that Druid works on
- [kiro-synth](https://github.com/chris-zen/kiro-synth) An in progress modular sound synthesizer.
- [psst](https://github.com/jpochyla/psst) A non-Electron GUI Spotify client.
- [flac_music](https://github.com/wandercn/flac_music) A music player.
- *pull requests welcome*
- *And many more*

## Projects that work with Druid (widgets etc)
- *pull requests welcome*
- *No data filled in here*

## Presentations
Some presentations about Druid, its background and related topics have been recorded
Expand Down
6 changes: 6 additions & 0 deletions druid-derive/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,10 @@

This crate contains the implementations of derive macros for [Druid].

## Project status

**UNMAINTAINED**

No further development is expected on `druid-derive`.

[Druid]: https://github.com/linebender/druid
10 changes: 7 additions & 3 deletions druid-shell/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# druid-shell

`druid-shell` provides a common interface to the various elements of different platform application
frameworks. It is designed to be used by [Druid], a UI toolkit.
frameworks. It was designed to be used by [Druid], an experimental UI toolkit.

## Project status

`druid-shell` v0.8 was forked to form [Glazier], which is where all new development happens.
No further development is expected on `druid-shell`. We recommend everyone migrates to [Glazier].
**UNMAINTAINED**

`druid-shell` v0.8 was forked to form [Glazier], which is where some additional development happened.
No further development is expected on `druid-shell` or [Glazier].
Our recommendation for new apps is to use [Winit].

## Design

Expand All @@ -28,3 +31,4 @@ a safe interface to `druid` and other possible consumers.

[Druid]: https://github.com/linebender/druid
[Glazier]: https://github.com/linebender/glazier
[Winit]: https://github.com/rust-windowing/winit
3 changes: 0 additions & 3 deletions druid/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,6 @@
//!
//! - png
//! - jpeg
//! - jpeg_rayon
//! - gif
//! - bmp
//! - ico
Expand All @@ -105,8 +104,6 @@
//! - pnm
//! - dds
//! - tga
//! - farbfeld
//! - dxt
//! - hdr
//!
//! You can enable all these formats with `image-all`.
Expand Down

0 comments on commit 55e2dd8

Please sign in to comment.