From 5790239c99dae598143399bdc8fa2c8ac5679fda Mon Sep 17 00:00:00 2001 From: FloVanGH Date: Thu, 12 Jun 2025 12:27:17 +0200 Subject: [PATCH] material: initial readme and contribution setup (https://github.com/slint-ui/material-components/issues/6) Imported from https://github.com/slint-ui/material-components/commit/8000c74b826f83b51e30d920053d71119a91eb48 --- ui-libraries/material/.gitignore | 2 ++ ui-libraries/material/CONTRIBUTING.md | 27 ++++++++++++++++ ui-libraries/material/README.md | 46 +++++++++++++++++++++++++++ 3 files changed, 75 insertions(+) create mode 100644 ui-libraries/material/CONTRIBUTING.md diff --git a/ui-libraries/material/.gitignore b/ui-libraries/material/.gitignore index 0f7b5b6071..a968c6d1be 100644 --- a/ui-libraries/material/.gitignore +++ b/ui-libraries/material/.gitignore @@ -7,3 +7,5 @@ package-lock.json .vscode/settings.json licenses/output *.bak +target/ +Cargo.lock diff --git a/ui-libraries/material/CONTRIBUTING.md b/ui-libraries/material/CONTRIBUTING.md new file mode 100644 index 0000000000..69c6caf09a --- /dev/null +++ b/ui-libraries/material/CONTRIBUTING.md @@ -0,0 +1,27 @@ + + +# Contributing + +We warmly welcome contributions to the project. Let's discuss ideas or questions +in [Github discussions](https://github.com/slint-ui/material-components/discussions). +Please feel welcome to open GitHub issues or pull requests. +Use 👍 reaction on issue that you consider important. + +Issues which we think are suitable for new contributors are tagged with +https://github.com/slint-ui/material-components/labels/good%20first%20issue. + +## Contributor License Agreement + +All contributions are accepted under the terms of the MIT No Attribution License. +Please note that you must have written the contribution 100% yourself and that +no rights have been transferred to third parties (e.g. your employer). +In any other case, please let us know. + +When opening a pull request, you will be asked to sign a +[Contributor License Agreement (CLA)](https://cla-assistant.io/slint-ui/material-components). + +## Coding Style + +For the Rust portion of the code base, the CI enforces the coding style via rustfmt. + + diff --git a/ui-libraries/material/README.md b/ui-libraries/material/README.md index 045f250557..a049ca78bc 100644 --- a/ui-libraries/material/README.md +++ b/ui-libraries/material/README.md @@ -1,2 +1,48 @@ + # Material Design 3 component set for Slint + +Welcome to the official Material Design 3 component set for [Slint](https://slint.dev). This repository provides a collection of UI components that adhere to [Material Design 3 guidelines](https://m3.material.io/). +The components are intended to use for development of user interfaces with Slint for Android apps, touch friendly interfaces for embedded devices and even for desktop application development. +Contributions and feedback from the community are welcome. + +[![Build status](https://github.com/slint-ui/material-components/actions/workflows/autofix.yaml/badge.svg)](https://github.com/slint-ui/material-components/actions/workflows/autofix.yaml) +[![REUSE status](https://api.reuse.software/badge/github.com/slint-ui/material-components)](https://api.reuse.software/info/github.com/slint-ui/slint) +[![Discussions](https://img.shields.io/github/discussions/slint-ui/material-components)](https://github.com/slint-ui/material-components/discussions) + +## Examples + +| Gallery | +| --------------------------------------------------------------------------------------------------------- | +| [Gallery![Gallery image](https://github.com/user-attachments/assets/e8031b78-4e7e-42fe-b34d-ef81a10defbe)](examples/gallery) | + +## Contributions + +We welcome your contributions: in the form of code, bug reports or feedback. +For contribution guidelines see [CONTRIBUTING.md](CONTRIBUTING.md). + +## About us (SixtyFPS GmbH) + +We are passionate about software - API design, cross-platform software +development and user interface components. Our aim is to make developing user +interfaces fun for everyone: from Python, JavaScript, C++, or Rust developers all the +way to UI/UX designers. We believe that software grows organically and keeping +it open source is the best way to sustain that growth. Our team members are +located remotely in Germany, Finland, and US. + +### Stay up to date + +- Follow [@slint_ui](https://twitter.com/slint_ui) on X/Twitter. +- Follow [@slint@fosstodon.org](https://mastodon.social/@slint@fosstodon.org) on Mastodon. +- Follow [@slint-ui](https://www.linkedin.com/company/slint-ui/) on LinkedIn. +- Follow [@slint.dev](https://bsky.app/profile/slint.dev) on Bluesky +- Subscribe to our [YouTube channel](https://www.youtube.com/@Slint-UI) + +### Contact us + +Feel free to join [Github discussions](https://github.com/slint-ui/material-components/discussions) +for general chat or questions. Use [Github issues](https://github.com/slint-ui/material-components/issues) +to report public suggestions or bugs. + +We chat in [our Mattermost instance](https://chat.slint.dev) where you are +welcome to listen in or ask your questions.