Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README Update #136

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .GitHub/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

liberapay : franksouza183
# Paypal: [email protected]
# custom : 'https://www.paypal.me/octocat'
79 changes: 79 additions & 0 deletions Documentation/Notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Notes & Usage

<br>

## Variants

The variants have been removed and will be replaced <br>
with a script that will generate a custom theme with <br>
the desired colors.

> I promise xD


You can still play with the **[Old Variants]**.

*Compatible with some windows ( wine ) applications.*

<br>
<br>

## Small Icons

All icons smaller or equal to `24px` are monochromatic, <br>with very few exceptions, preventing consistency break.

So, if you see small colorful icons, it is because they <br>
haven't been covered yet or maybe it's hard-coded.

<br>
<br>

## Transitioning

The package is in the process of migrating to <br>
the new style, so expect icons with the old one.

*I am currently focusing on the most popular.*

<br>
<br>

## Dark Themes

When using dark themes, the small <br>
icons will be visible by bright outlines.

If you don't want this, you can use the **[Colorizer]** tool <br>
created by **[@ElectronicsArchiver]** and colorize all<br>
monochromatic icons to your taste. Here's<br>
an example using the included EvolvereDark template:

```sh
./path_to_evolvere/Tools/Colorize.js \
./path_to_evolvere/Resources/Examples/EvolvereDark.yaml
```

<br>

A new directory `Build` will be created on root level<br>
of the Evolvere Icons cloned repository, just rename<br>
it and move to `~/.local/share/icons` or to<br>
`/usr/share/icons` for multi user compatibility.

<br>
<br>

## Live Preview

Open `Resources/preview.svg` <br>
in **[Inkscape]** for a *'live'* preview.

<br>


<!----------------------------------------------------------------------------->

[@ElectronicsArchiver]: https://github.com/ElectronicsArchiver
[Inkscape]: https://inkscape.org/

[Colorizer]: Documentation/Colorize/Usage.md
134 changes: 37 additions & 97 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,139 +1,79 @@
[![Badge License]][License]

<div align = center>

# Evolvere Icons

***Flat with Touches of Realism***

<br>

![Preview]

</div>

---

<div align = center>

[<kbd> <br> Install <br> </kbd>][Install] 
[<kbd> <br> Colorize <br> </kbd>][Colorize] 
[<kbd> <br> Changelog <br> </kbd>][Changelog]

</div>

---
[![Badge Contribute]][Issues]   
[![Badge License]][License]

<br>
<br>

## Design

- **Minimalist / Monochromatic**

- **Realistic Shading**

*As far as I'm able to~*

- **Smooth Colors**

- **Square**
# Evolvere Icons

- **Small**
***Flat with Touches of Realism***

<br>

---

<br>

## Notes

#### Variants

The variants have been removed and will be replaced <br>
with a script that will generate a custom theme with <br>
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]

<br>

#### Small Icons

All icons smaller or equal to `24px` are monochromatic, <br>with very few exceptions, preventing consistency break.

So, if you see small colorful icons, it is because they <br>
haven't been covered yet or maybe it's hard-coded.

<br>

#### Transitioning

The package is in the process of migrating to <br>
the new style, so expect icons with the old one.
![Preview]

*I am currently focusing on the most popular.*

<br>
<br>

#### Dark Themes

When using dark themes, the small <br>
icons will be visible by bright outlines.<br>
If you don't want this, you can use the [Colorize][Colorize] tool<br>
created by [@ElectronicsArchiver](https://github.com/ElectronicsArchiver) and colorize all<br>
monochromatic icons to your taste. Here's<br>
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

<br>

A new directory `Build` will be created on root level<br>
of the Evolvere Icons cloned repository, just rename<br>
it and move to `~/.local/share/icons` or to<br>
`/usr/share/icons` for multi user compatibility.
**Minimalist / Monochromatic**

<br>
**Realistic Shading**

#### Live Preview
*As far as I'm able to~*

**Smooth Colors**

Open `Resources/preview.svg` <br>
in **[Inkscape]** for a *'live'* preview.
**Square**

<br>
**Small**

---
</div>

<br>

## 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)<br>
Paypal: [email protected]

<!----------------------------------------------------------------------------->
<!----------------------------------[ Badges ]--------------------------------->

[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/
<!---------------------------------[ Buttons ]--------------------------------->

[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