https://github.com/mondeja/simple-icons-utils
Utilities for review icons in simple-icons
https://github.com/mondeja/simple-icons-utils
Last synced: 8 months ago
JSON representation
Utilities for review icons in simple-icons
- Host: GitHub
- URL: https://github.com/mondeja/simple-icons-utils
- Owner: mondeja
- License: bsd-3-clause
- Created: 2020-11-17T13:21:23.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-02T03:04:57.000Z (almost 2 years ago)
- Last Synced: 2025-02-13T20:17:55.146Z (8 months ago)
- Language: Shell
- Size: 34.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Usage
These scripts suppose that:
- You have `inkscape` installed (v1.0.0 at least).
- You are in Linux using Bash.
## Install
1. Clone this repository at `simple-icons/utils`. Use next command from
`simple-icons` directory root:
```
git clone https://github.com/mondeja/simple-icons-utils.git utils
```
2. Install SVGO globally with `npm install -g svgo`
## Scripts
### Start a review for a remote branch
```bash
bash utils/review/start-review.sh "" "" ""
```
### Scale icon to 24px size and align to center
```bash
bash utils/review/inkscape-scale-align-center.sh "" ""
```
### Open two icons for compare them manually
```bash
bash utils/review/inkscape-gui-compare.sh [-c] "" ""
```
### Query icon dimensions
```bash
bash utils/review/inkscape-dimensions.sh ""
```
### Print differences between icons
```bash
bash utils/review/diff.sh "" ""
```
## Usual workflow
Supposing that you want to review
[this pull](https://github.com/simple-icons/simple-icons/pull/3860) (Twitter
icon correction pull-requested by @service-paradis). You can follow next steps:
1. You are in another branch (could be `develop` or other). Execute:
```bash
bash utils/review/start-review.sh twitter service-paradis twitter-review
```
This will create the directory `_review/twitter/` and will place the original
`twitter.svg` icon inside it with the name of `original.svg`.
2. You should correct the size and the alignment of the icon. Manually with
Inkscape the following repetitive tasks are followed: block width/height scale
factor, see what is the maximum axis size (width or height), adjust that size
to 24px, go to `Object` -> `Align and distribute`, and center in both axis.
This can be automated by next command:
```bash
bash utils/review/inkscape-scale-align-center.sh _review/twitter/original.svg _review/twitter/autofixed.svg
```
A new icon will appear at `_review/twitter/autofixed.svg`.
3. We can now compare the pull requested icon with the autogenerated version
using GIT diffs:
```bash
bash utils/review/diff.sh _review/twitter/autofixed.svg icons/twitter.svg
```
4. If the paths does not match with the new version you can review it manually.
There is another script in this repository that can open both files in Inkscape,
coloring one of them in red, so you don't need to prepare the review manually:
```bash
bash utils/review/inkscape-gui-compare.sh _review/twitter/autofixed.svg icons/twitter.svg
```
> Note that this workflow can only be used for icons that must be corrected
only, but updates or new icons do not follows this workflow. However, you can
use some of the scripts to make easy repetitive tasks.