From 25c93c7f6e9ea8afd38fc0c31041209be0b6a9f5 Mon Sep 17 00:00:00 2001 From: Frank Ray <52075808+FrankRay78@users.noreply.github.com> Date: Fri, 8 Mar 2024 15:46:05 +0000 Subject: [PATCH 1/7] Grammatical improvements --- README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index fd01732a0..77bf0dd0c 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,7 @@ _[![Spectre.Console NuGet Version](https://img.shields.io/nuget/v/spectre.console.svg?style=flat&label=NuGet%3A%20Spectre.Console)](https://www.nuget.org/packages/spectre.console)_ _[![Spectre.Console CLI NuGet Version](https://img.shields.io/nuget/v/spectre.console.cli.svg?style=flat&label=NuGet%3A%20Spectre.Console.Cli)](https://www.nuget.org/packages/spectre.console.cli)_ [![Netlify Status](https://api.netlify.com/api/v1/badges/1eaf215a-eb9c-45e4-8c64-c90b62963149/deploy-status)](https://app.netlify.com/sites/spectreconsole/deploys) A .NET library that makes it easier to create beautiful, cross platform, console applications. -It is heavily inspired by the excellent [Rich library](https://github.com/willmcgugan/rich) -for Python. For detailed usage instructions, [please refer to the documentation at https://spectreconsole.net/.](https://spectreconsole.net/) +It is heavily inspired by the excellent Python library, [Rich](https://github.com/willmcgugan/rich). Detailed instructions for using `Spectre.Console` are located on the project website, https://spectreconsole.net. ## Table of Contents @@ -20,7 +19,7 @@ for Python. For detailed usage instructions, [please refer to the documentation ## Features * Written with unit testing in mind. -* Supports tables, grids, panels, and a [rich](https://github.com/willmcgugan/rich) inspired markup language. +* Supports tables, grids, panels, and a [Rich](https://github.com/willmcgugan/rich) inspired markup language. * Supports the most common SRG parameters when it comes to text styling such as bold, dim, italic, underline, strikethrough, and blinking text. @@ -42,7 +41,7 @@ dotnet add package Spectre.Console ## Documentation The documentation for `Spectre.Console` can be found at -https://spectreconsole.net/ +https://spectreconsole.net ## Examples @@ -69,7 +68,7 @@ And to run an example: ## Sponsors The following people are [sponsoring](https://github.com/sponsors/patriksvensson) -Spectre.Console to show their support and to ensure the longevity of the project. +`Spectre.Console` to show their support and to ensure the longevity of the project. * [Rodney Littles II](https://github.com/RLittlesII) * [Martin Björkström](https://github.com/bjorkstromm) @@ -99,6 +98,6 @@ This project is supported by the [.NET Foundation](https://dotnetfoundation.org) Copyright © Patrik Svensson, Phil Scott, Nils Andresen -Spectre.Console is provided as-is under the MIT license. For more information see LICENSE. +`Spectre.Console` is provided as-is under the MIT license. For more information see LICENSE. -* SixLabors.ImageSharp, a library which Spectre.Console relies upon, is licensed under Apache 2.0 when distributed as part of Spectre.Console. The Six Labors Split License covers all other usage, see: https://github.com/SixLabors/ImageSharp/blob/master/LICENSE +* SixLabors.ImageSharp, a library which `Spectre.Console` relies upon, is licensed under Apache 2.0 when distributed as part of `Spectre.Console`. The Six Labors Split License covers all other usage, see: https://github.com/SixLabors/ImageSharp/blob/master/LICENSE From aad4fea44211e89a69eb93522325a0fb195f1536 Mon Sep 17 00:00:00 2001 From: Frank Ray <52075808+FrankRay78@users.noreply.github.com> Date: Fri, 8 Mar 2024 16:01:22 +0000 Subject: [PATCH 2/7] Added 'Important Notices' section --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 77bf0dd0c..e6700d2c9 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ _[![Spectre.Console NuGet Version](https://img.shields.io/nuget/v/spectre.console.svg?style=flat&label=NuGet%3A%20Spectre.Console)](https://www.nuget.org/packages/spectre.console)_ _[![Spectre.Console CLI NuGet Version](https://img.shields.io/nuget/v/spectre.console.cli.svg?style=flat&label=NuGet%3A%20Spectre.Console.Cli)](https://www.nuget.org/packages/spectre.console.cli)_ [![Netlify Status](https://api.netlify.com/api/v1/badges/1eaf215a-eb9c-45e4-8c64-c90b62963149/deploy-status)](https://app.netlify.com/sites/spectreconsole/deploys) A .NET library that makes it easier to create beautiful, cross platform, console applications. -It is heavily inspired by the excellent Python library, [Rich](https://github.com/willmcgugan/rich). Detailed instructions for using `Spectre.Console` are located on the project website, https://spectreconsole.net. +It is heavily inspired by the excellent Python library, [Rich](https://github.com/willmcgugan/rich). Detailed instructions for using `Spectre.Console` are located on the project website, https://spectreconsole.net ## Table of Contents @@ -27,9 +27,13 @@ It is heavily inspired by the excellent Python library, [Rich](https://github.co The library will detect the capabilities of the current terminal and downgrade colors as needed. - ![Example](docs/input/assets/images/example.png) +## Important Notices + +> [!IMPORTANT]\ +> We're a small team, and to prioritize, we rely on upvotes :+1:. We use the [Top Issues Dashboard]() for tracking community demand. Do not hesitate to upvote the issues and pull requests you are interested in. We work on the most upvoted first. + ## Installing The fastest way of getting started using `Spectre.Console` is to install the NuGet package. From f1f979597b8f62bcfc748ad4ff0002bc18c4189b Mon Sep 17 00:00:00 2001 From: Frank Ray <52075808+FrankRay78@users.noreply.github.com> Date: Fri, 8 Mar 2024 16:08:54 +0000 Subject: [PATCH 3/7] Minor stylistic change --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e6700d2c9..d6c0be16c 100644 --- a/README.md +++ b/README.md @@ -18,14 +18,14 @@ It is heavily inspired by the excellent Python library, [Rich](https://github.co ## Features -* Written with unit testing in mind. * Supports tables, grids, panels, and a [Rich](https://github.com/willmcgugan/rich) inspired markup language. * Supports the most common SRG parameters when it comes to text styling such as bold, dim, italic, underline, strikethrough, and blinking text. * Supports 3/4/8/24-bit colors in the terminal. The library will detect the capabilities of the current terminal - and downgrade colors as needed. + and downgrade colors as needed. +* Written with unit testing in mind. ![Example](docs/input/assets/images/example.png) From 7941109acf0eecdf7e1516d16b967d2c74a95baa Mon Sep 17 00:00:00 2001 From: Frank Ray <52075808+FrankRay78@users.noreply.github.com> Date: Sun, 10 Mar 2024 16:15:13 +0000 Subject: [PATCH 4/7] Simplified the upvote statement --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d6c0be16c..b61c5d4a8 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ It is heavily inspired by the excellent Python library, [Rich](https://github.co ## Important Notices > [!IMPORTANT]\ -> We're a small team, and to prioritize, we rely on upvotes :+1:. We use the [Top Issues Dashboard]() for tracking community demand. Do not hesitate to upvote the issues and pull requests you are interested in. We work on the most upvoted first. +> We use the [Top Issues Dashboard]() for tracking community demand. Please upvote :+1: the issues and pull requests you are interested in. ## Installing From 7d3feb4134809f5d5d4f442486545a6cefe2fb0b Mon Sep 17 00:00:00 2001 From: Frank Ray <52075808+FrankRay78@users.noreply.github.com> Date: Sun, 10 Mar 2024 17:43:52 +0000 Subject: [PATCH 5/7] Added the 'Please upvote...' footer message to the new issue/PR template --- .github/ISSUE_TEMPLATE/bug_report.md | 3 +++ .github/ISSUE_TEMPLATE/feature_request.md | 3 +++ .github/pull_request_template.md | 3 +++ 3 files changed, 9 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index b12a8feb1..d81d95682 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -26,3 +26,6 @@ If applicable, add screenshots to help explain your problem. **Additional context** Add any other context about the problem here. + +--- +_Please upvote :+1: this issue if you are interested in it._ \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index dc6ee2fcc..0f89d03c8 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -18,3 +18,6 @@ A clear and concise description of any alternative solutions or features you've **Additional context** Add any other context or screenshots about the feature request here. + +--- +_Please upvote :+1: this issue if you are interested in it._ \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index e93dabf58..00c9c2305 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -17,3 +17,6 @@ fixes # ## Changes + +--- +_Please upvote :+1: this pull request if you are interested in it._ \ No newline at end of file From 08f09c06453109e07e1348bdfc200844c8b31169 Mon Sep 17 00:00:00 2001 From: Frank Ray <52075808+FrankRay78@users.noreply.github.com> Date: Tue, 12 Mar 2024 15:13:57 +0000 Subject: [PATCH 6/7] Removed the italicised 'Please upvote' footer For better readability when looking at the issue description (eyes don't get caught on the italics when scanning). --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- .github/pull_request_template.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index d81d95682..224a1d312 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -28,4 +28,4 @@ If applicable, add screenshots to help explain your problem. Add any other context about the problem here. --- -_Please upvote :+1: this issue if you are interested in it._ \ No newline at end of file +Please upvote :+1: this issue if you are interested in it. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 0f89d03c8..dd40949e9 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -20,4 +20,4 @@ A clear and concise description of any alternative solutions or features you've Add any other context or screenshots about the feature request here. --- -_Please upvote :+1: this issue if you are interested in it._ \ No newline at end of file +Please upvote :+1: this issue if you are interested in it. \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 00c9c2305..8604355d6 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -19,4 +19,4 @@ fixes # --- -_Please upvote :+1: this pull request if you are interested in it._ \ No newline at end of file +Please upvote :+1: this pull request if you are interested in it. \ No newline at end of file From d347cd5e2a4cde809a75428f10fc241b3fd7a210 Mon Sep 17 00:00:00 2001 From: Frank Ray <52075808+FrankRay78@users.noreply.github.com> Date: Mon, 15 Apr 2024 16:23:05 +0100 Subject: [PATCH 7/7] Added url to the Top Issues Dashboard --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b61c5d4a8..85a6e1f15 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ It is heavily inspired by the excellent Python library, [Rich](https://github.co ## Important Notices > [!IMPORTANT]\ -> We use the [Top Issues Dashboard]() for tracking community demand. Please upvote :+1: the issues and pull requests you are interested in. +> We use the [Top Issues Dashboard](https://github.com/spectreconsole/spectre.console/issues/1517) for tracking community demand. Please upvote :+1: the issues and pull requests you are interested in. ## Installing