From e5b8c2deb35a1bc1ddc35a2201a0fa4cbf3b7054 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Thu, 4 Aug 2022 06:22:41 -0400 Subject: [PATCH 1/5] Added Funding --- .GitHub/FUNDING.yml | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 .GitHub/FUNDING.yml diff --git a/.GitHub/FUNDING.yml b/.GitHub/FUNDING.yml new file mode 100644 index 00000000..0600e9b7 --- /dev/null +++ b/.GitHub/FUNDING.yml @@ -0,0 +1,2 @@ + +liberapay : franksouza183 From bf13c312b5a17a1fe618db19a83316001830f4b9 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Thu, 4 Aug 2022 06:29:28 -0400 Subject: [PATCH 2/5] Adjusted Filepath --- {.github => .GitHub}/ISSUE_TEMPLATE/Suggest Icons.yaml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename {.github => .GitHub}/ISSUE_TEMPLATE/Suggest Icons.yaml (100%) diff --git a/.github/ISSUE_TEMPLATE/Suggest Icons.yaml b/.GitHub/ISSUE_TEMPLATE/Suggest Icons.yaml similarity index 100% rename from .github/ISSUE_TEMPLATE/Suggest Icons.yaml rename to .GitHub/ISSUE_TEMPLATE/Suggest Icons.yaml From 6b94234bb617bc919db2ac2ddc5cc04540270ea0 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Thu, 4 Aug 2022 06:32:38 -0400 Subject: [PATCH 3/5] Temporary Funding --- .GitHub/FUNDING.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.GitHub/FUNDING.yml b/.GitHub/FUNDING.yml index 0600e9b7..c926b0c4 100644 --- a/.GitHub/FUNDING.yml +++ b/.GitHub/FUNDING.yml @@ -1,2 +1,4 @@ liberapay : franksouza183 +# Paypal: franksouza183@gmail.com +# custom : 'https://www.paypal.me/octocat' From 7475d61a6f78ddfdd2eb1de3efaa30e47adf524c Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Thu, 4 Aug 2022 06:35:33 -0400 Subject: [PATCH 4/5] Formatted README --- Documentation/Notes.md | 79 ++++++++++++++++++++++++ README.md | 133 +++++++++++------------------------------ 2 files changed, 115 insertions(+), 97 deletions(-) create mode 100644 Documentation/Notes.md diff --git a/Documentation/Notes.md b/Documentation/Notes.md new file mode 100644 index 00000000..c59620ca --- /dev/null +++ b/Documentation/Notes.md @@ -0,0 +1,79 @@ +# Notes & Usage + +
+ +## Variants + +The variants have been removed and will be replaced
+with a script that will generate a custom theme with
+the desired colors. + +> I promise xD + + +You can still play with the **[Old Variants]**. + +*Compatible with some windows ( wine ) applications.* + +
+
+ +## Small Icons + +All icons smaller or equal to `24px` are monochromatic,
with very few exceptions, preventing consistency break. + +So, if you see small colorful icons, it is because they
+haven't been covered yet or maybe it's hard-coded. + +
+
+ +## Transitioning + +The package is in the process of migrating to
+the new style, so expect icons with the old one. + +*I am currently focusing on the most popular.* + +
+
+ +## Dark Themes + +When using dark themes, the small
+icons will be visible by bright outlines. + +If you don't want this, you can use the **[Colorizer]** tool
+created by **[@ElectronicsArchiver]** and colorize all
+monochromatic icons to your taste. Here's
+an example using the included EvolvereDark template: + +```sh +./path_to_evolvere/Tools/Colorize.js \ + ./path_to_evolvere/Resources/Examples/EvolvereDark.yaml +``` + +
+ +A new directory `Build` will be created on root level
+of the Evolvere Icons cloned repository, just rename
+it and move to `~/.local/share/icons` or to
+`/usr/share/icons` for multi user compatibility. + +
+
+ +## Live Preview + +Open `Resources/preview.svg`
+in **[Inkscape]** for a *'live'* preview. + +
+ + + + +[@ElectronicsArchiver]: https://github.com/ElectronicsArchiver +[Inkscape]: https://inkscape.org/ + +[Colorizer]: Documentation/Colorize/Usage.md diff --git a/README.md b/README.md index d1695193..e80990ee 100644 --- a/README.md +++ b/README.md @@ -1,139 +1,78 @@ -[![Badge License]][License] - -
- -# Evolvere Icons - -***Flat with Touches of Realism***
-![Preview] - -
- ---- -
-[ 
 Install 
 ][Install]  -[ 
 Colorize 
 ][Colorize]  -[ 
 Changelog 
 ][Changelog] - -
- ---- +[![Badge Contribute]][Issues]    +[![Badge License]][License]
-## Design - -- **Minimalist / Monochromatic** - -- **Realistic Shading** - - *As far as I'm able to~* - -- **Smooth Colors** - -- **Square** +# Evolvere Icons -- **Small** +***Flat with Touches of Realism***
- ---- -
-## Notes - -#### Variants - -The variants have been removed and will be replaced
-with a script that will generate a custom theme with
-the desired colors. - -> I promise xD - - -You can still play with the **[Old Variants]**. - -*Compatible with some windows ( wine ) applications.* +[![Button Install]][Install]    +[![Button Notes]][Notes]    +[![Button Colorizer]][Colorizer]    +[![Button Changelog]][Changelog]
- -#### Small Icons - -All icons smaller or equal to `24px` are monochromatic,
with very few exceptions, preventing consistency break. - -So, if you see small colorful icons, it is because they
-haven't been covered yet or maybe it's hard-coded. -
-#### Transitioning - -The package is in the process of migrating to
-the new style, so expect icons with the old one. +![Preview] -*I am currently focusing on the most popular.* +

-#### Dark Themes - -When using dark themes, the small
-icons will be visible by bright outlines.
-If you don't want this, you can use the [Colorize][Colorize] tool
-created by [@ElectronicsArchiver](https://github.com/ElectronicsArchiver) and colorize all
-monochromatic icons to your taste. Here's
-an example using the included EvolvereDark template: - -```./local_path/to/evolvere-icons-repository/Tools/Colorize.js ./local_path/to/evolvere-icons-repository/Resources/Examples/EvolvereDark.yaml"``` +## Design
-A new directory `Build` will be created on root level
-of the Evolvere Icons cloned repository, just rename
-it and move to `~/.local/share/icons` or to
-`/usr/share/icons` for multi user compatibility. +**Minimalist / Monochromatic** -
+**Realistic Shading** -#### Live Preview +*As far as I'm able to~* + +**Smooth Colors** -Open `Resources/preview.svg`
-in **[Inkscape]** for a *'live'* preview. +**Square** -
+**Small** ---- +
-## Contributions -Simply open an issue / pull request. + -*For missing icons for example.* +[Old Variants]: https://github.com/franksouza183/EvolvereSuit +[Issues]: https://github.com/franksouza183/Evolvere-Icons/issues -Or buy me a coffee~ +[Colorizer]: Documentation/Colorize/Usage.md +[Changelog]: Documentation/Changelog.md +[Preview]: Resources/preview.png 'Showcase of the Evolvere Icons set' +[Install]: Documentation/Installation.md +[License]: LICENSE 'This project is licensed under CreativeCommons BY SA 4.0' +[Notes]: Documentation/Notes.md -[LiberaPay](https://liberapay.com/franksouza183/donate)
-Paypal: franksouza183@gmail.com - + -[Badge License]: https://licensebuttons.net/l/by-sa/4.0/80x15.png +[Badge Contribute]: https://img.shields.io/badge/Contributions-Welcome-33670f.svg?style=for-the-badge&labelColor=428813&logoColor=white&logo=GitHub +[Badge License]: https://img.shields.io/badge/-BY_SA-ae6c18.svg?style=for-the-badge&labelColor=EF9421&logoColor=white&logo=CreativeCommons -[Preview]: Resources/preview.png 'Preview of the Evolvere Icons set' -[Inkscape]: https://inkscape.org/ + -[Old Variants]: https://github.com/franksouza183/EvolvereSuit +[Button Colorizer]: https://img.shields.io/badge/Colorizer-428813?style=for-the-badge&logoColor=white&logo=GoogleSearchConsole +[Button Changelog]: https://img.shields.io/badge/Changelog-EF9421?style=for-the-badge&logoColor=white&logo=AzureArtifacts +[Button Install]: https://img.shields.io/badge/Install-C9284D?style=for-the-badge&logoColor=white&logo=DocuSign +[Button Notes]: https://img.shields.io/badge/Notes_&_Usage-1578D3?style=for-the-badge&logoColor=white&logo=GitBook -[Changelog]: Documentation/Changelog.md -[Colorize]: Documentation/Colorize/Usage.md -[Install]: Documentation/Installation.md -[License]: LICENSE From dfe1e9fc82ee43b0935a0bfbcc353be8fbb17971 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?= <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Thu, 4 Aug 2022 06:36:20 -0400 Subject: [PATCH 5/5] Adjusted Spacing --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index e80990ee..749d74bf 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ [![Badge Contribute]][Issues]    [![Badge License]][License] +

# Evolvere Icons