https://github.com/nilsding/breeze-icons-ruby
A subset of the KDE Plasma Breeze icon set packaged as a gem
https://github.com/nilsding/breeze-icons-ruby
Last synced: over 1 year ago
JSON representation
A subset of the KDE Plasma Breeze icon set packaged as a gem
- Host: GitHub
- URL: https://github.com/nilsding/breeze-icons-ruby
- Owner: nilsding
- License: lgpl-3.0
- Created: 2023-09-01T14:30:50.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-01T14:34:04.000Z (almost 3 years ago)
- Last Synced: 2025-03-06T15:19:42.366Z (over 1 year ago)
- Language: Ruby
- Homepage: https://nilsding.github.io/breeze-icons-ruby/
- Size: 537 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# breeze-icons-ruby
This gem provides a subset of the excellent
[KDE Breeze Icons](https://invent.kde.org/frameworks/breeze-icons) as a gem.
It mostly only contains the "symbolic" icons which make it perfect for using it
on websites without resorting to an icon font.
Inspired by [octicons](https://github.com/primer/octicons/tree/main/lib/octicons_gem).
## Installation
Install the gem and add to the application's Gemfile by executing:
```sh
$ bundle add breeze_icons
```
If bundler is not being used to manage dependencies, install the gem by executing:
```sh
$ gem install breeze_icons
```
## Usage
```ruby
require "breeze_icons"
icon = BreezeIcons::Icon.new("media-playback-start")
icon.to_svg
#
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run
`rake test` to run the tests. You can also run `bin/console` for an
interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`.
To release a new version, update the version number in `version.rb`, and then
run `bundle exec rake release`, which will create a git tag for the version,
push git commits and the created tag, and push the `.gem` file to
[rubygems.org](https://rubygems.org).
To update the `breeze_icons` data file run:
```sh
rake generate_data_file
```
To generate a demo page with all the icons the gem supports:
```sh
rake generate_demo_page
```
## Contributing
Bug reports and pull requests are welcome on GitHub at
https://github.com/nilsding/breeze-icons-ruby. This project is intended to be
a safe, welcoming space for collaboration, and contributors are expected to
adhere to the [code of conduct](https://github.com/nilsding/breeze-icons-ruby/blob/main/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the
[LGPLv3 Licence](https://opensource.org/license/lgpl-3-0/).
The icon data is licensed under the terms of LGPLv3 as per
https://invent.kde.org/frameworks/breeze-icons/-/blob/master/COPYING-ICONS.
## Code of Conduct
Everyone interacting in the BreezeIcons project's codebases, issue trackers,
chat rooms and mailing lists is expected to follow the
[code of conduct](https://github.com/nilsding/breeze-icons-ruby/blob/main/CODE_OF_CONDUCT.md).