From e949962a0d784b251166cc327d88e2c8236b9df9 Mon Sep 17 00:00:00 2001 From: Matthias Ngeo Date: Wed, 6 Nov 2024 14:39:38 +0800 Subject: [PATCH] Hopefully fix README lints --- LICENSE | 87 +++++++++++++++++++ README.md | 5 +- forui/README.md | 11 +-- forui/lib/src/widgets/alert.dart | 2 +- .../lib/src/widgets/header/header_action.dart | 4 +- forui/pubspec.yaml | 4 +- forui_assets/README.md | 6 +- lychee.toml | 13 +++ 8 files changed, 117 insertions(+), 15 deletions(-) diff --git a/LICENSE b/LICENSE index bca07f2e9..4ab04827e 100644 --- a/LICENSE +++ b/LICENSE @@ -22,3 +22,90 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +----------------------------------------------------------- +SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 +----------------------------------------------------------- + +PREAMBLE +The goals of the Open Font License (OFL) are to stimulate worldwide +development of collaborative font projects, to support the font creation +efforts of academic and linguistic communities, and to provide a free and +open framework in which fonts may be shared and improved in partnership +with others. + +The OFL allows the licensed fonts to be used, studied, modified and +redistributed freely as long as they are not sold by themselves. The +fonts, including any derivative works, can be bundled, embedded, +redistributed and/or sold with any software provided that any reserved +names are not used by derivative works. The fonts and derivatives, +however, cannot be released under any other type of license. The +requirement for fonts to remain under this license does not apply +to any document created using the fonts or their derivatives. + +DEFINITIONS +"Font Software" refers to the set of files released by the Copyright +Holder(s) under this license and clearly marked as such. This may +include source files, build scripts and documentation. + +"Reserved Font Name" refers to any names specified as such after the +copyright statement(s). + +"Original Version" refers to the collection of Font Software components as +distributed by the Copyright Holder(s). + +"Modified Version" refers to any derivative made by adding to, deleting, +or substituting -- in part or in whole -- any of the components of the +Original Version, by changing formats or by porting the Font Software to a +new environment. + +"Author" refers to any designer, engineer, programmer, technical +writer or other person who contributed to the Font Software. + +PERMISSION & CONDITIONS +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Font Software, to use, study, copy, merge, embed, modify, +redistribute, and sell modified and unmodified copies of the Font +Software, subject to the following conditions: + +1) Neither the Font Software nor any of its individual components, +in Original or Modified Versions, may be sold by itself. + +2) Original or Modified Versions of the Font Software may be bundled, +redistributed and/or sold with any software, provided that each copy +contains the above copyright notice and this license. These can be +included either as stand-alone text files, human-readable headers or +in the appropriate machine-readable metadata fields within text or +binary files as long as those fields can be easily viewed by the user. + +3) No Modified Version of the Font Software may use the Reserved Font +Name(s) unless explicit written permission is granted by the corresponding +Copyright Holder. This restriction only applies to the primary font name as +presented to the users. + +4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font +Software shall not be used to promote, endorse or advertise any +Modified Version, except to acknowledge the contribution(s) of the +Copyright Holder(s) and the Author(s) or with their explicit written +permission. + +5) The Font Software, modified or unmodified, in part or in whole, +must be distributed entirely under this license, and must not be +distributed under any other license. The requirement for fonts to +remain under this license does not apply to any document created +using the Font Software. + +TERMINATION +This license becomes null and void if any of the above conditions are +not met. + +DISCLAIMER +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE +COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL +DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM +OTHER DEALINGS IN THE FONT SOFTWARE. diff --git a/README.md b/README.md index 59a6eb6b7..9240dc92a 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@

- Forui is a UI library for Flutter that provides a set of minimalistic widgets heavily inspired by shadcn/ui. + Forui is a UI library for Flutter that provides a set of beautifully designed, minimalistic widgets.


@@ -41,4 +41,5 @@ Please read the [contributing guide](/CONTRIBUTING.md). ## License -Licensed under the [MIT license](/LICENSE.md). +Code is licensed under the [MIT License](LICENSE). +Icons are licensed under [Open Font License](LICENSE). diff --git a/forui/README.md b/forui/README.md index a36b6dd6d..ff9f4604f 100644 --- a/forui/README.md +++ b/forui/README.md @@ -9,16 +9,17 @@ Pub Version GitHub Repo stars GitHub commit activity + Discord Server

📚 Documentation • - 🖼️ Widgets • + 🖼️ Widgets • 🤓 API Reference

- Forui is a UI library for Flutter that provides a set of minimalistic widgets heavily inspired by shadcn/ui. + Forui is a UI library for Flutter that provides a set of beautifully designed, minimalistic widgets.


@@ -32,9 +33,9 @@ Visit [forui.dev/docs](https://forui.dev/docs) to view the documentation. ## Contributing -Please read the [contributing guide](/CONTRIBUTING.md). +Please read the [contributing guide](https://github.com/forus-labs/forui/blob/main/CONTRIBUTING.md). ## License -Licensed under the [MIT license](/LICENSE.md). - +Licensed under the [MIT License](https://github.com/forus-labs/forui/blob/main/forui/LICENSE) and [Open Font License] +(https://github.com/forus-labs/forui/blob/main/forui/LICENSE). \ No newline at end of file diff --git a/forui/lib/src/widgets/alert.dart b/forui/lib/src/widgets/alert.dart index 753ae1008..c7ef8c146 100644 --- a/forui/lib/src/widgets/alert.dart +++ b/forui/lib/src/widgets/alert.dart @@ -13,7 +13,7 @@ import 'package:forui/forui.dart'; /// * https://forui.dev/docs/navigation/alert for working examples. /// * [FAlertStyle] for customizing an alert's appearance. class FAlert extends StatelessWidget { - /// The icon. Defaults to [FAssets.icons.circleAlert]. + /// The icon. Defaults to `FAssets.icons.circleAlert`. /// /// [icon] is wrapped in [FIconStyle], and therefore works with [FIcon]s. final Widget icon; diff --git a/forui/lib/src/widgets/header/header_action.dart b/forui/lib/src/widgets/header/header_action.dart index 691603e70..7f5c84034 100644 --- a/forui/lib/src/widgets/header/header_action.dart +++ b/forui/lib/src/widgets/header/header_action.dart @@ -35,7 +35,7 @@ class FHeaderAction extends StatelessWidget { super.key, }); - /// Creates a [FHeaderAction] with [FAssets.icons.arrowLeft]. + /// Creates a [FHeaderAction] with `FAssets.icons.arrowLeft`. factory FHeaderAction.back({ required VoidCallback? onPress, FHeaderActionStyle? style, @@ -50,7 +50,7 @@ class FHeaderAction extends StatelessWidget { key: key, ); - /// Creates a [FHeaderAction] with [FAssets.icons.x]. + /// Creates a [FHeaderAction] with `FAssets.icons.x`. factory FHeaderAction.x({ required VoidCallback? onPress, FHeaderActionStyle? style, diff --git a/forui/pubspec.yaml b/forui/pubspec.yaml index 23739bc98..28e75fd31 100644 --- a/forui/pubspec.yaml +++ b/forui/pubspec.yaml @@ -1,5 +1,5 @@ name: forui -description: Forui is a UI library for Flutter that provides a set of minimalistic widgets heavily inspired by Shadcn/ui. +description: Beautifully designed, minimalistic widgets for desktop & touch devices. version: 0.6.1 homepage: https://forui.dev/ documentation: https://forui.dev/docs @@ -10,7 +10,7 @@ topics: - widget environment: - sdk: ">=3.3.0 <4.0.0" + sdk: ">=3.5.0 <4.0.0" flutter: ">=3.24.0" dependencies: diff --git a/forui_assets/README.md b/forui_assets/README.md index a2049e1a9..ebc76e6d8 100644 --- a/forui_assets/README.md +++ b/forui_assets/README.md @@ -1,7 +1,7 @@ # Forui Assets -Companion assets for [Forui](../forui), a UI library for Flutter that provides a set of minimalistic widgets heavily -inspired by [shadcn/ui](https://ui.shadcn.com/). +Companion assets for [Forui](../forui), a UI library for Flutter that provides a set of a set of beautifully designed, +minimalistic widgets. It includes icons from [Lucide Icons](https://lucide.dev/icons/). @@ -15,4 +15,4 @@ Please read the [contributing guide](../CONTRIBUTING.md). ## License -Licensed under the [MIT license](/LICENSE.md). +Licensed under the [MIT License](/LICENSE) & [ISC license](/LICENSE). diff --git a/lychee.toml b/lychee.toml index e69de29bb..eaf80d13d 100644 --- a/lychee.toml +++ b/lychee.toml @@ -0,0 +1,13 @@ +exclude_path = [ + "doc/**", + "forui/example/**", + "forui/src/**", + "forui/lib/**", + "forui/example/**", + "forui_assets/lib/**", + "samples/android/**", + "samples/ios/**", + "samples/macos/**", + "samples/web/**", + "samples/lib/**", +] \ No newline at end of file