mirror of
https://github.com/andrewgioia/keyrune.git
synced 2024-12-22 15:39:56 +00:00
Slight updates to contributing docs, fixes version in a few places, adds to changelog
This commit is contained in:
parent
6bdaa36444
commit
3a7d6663b4
11
CHANGELOG.md
11
CHANGELOG.md
@ -11,6 +11,17 @@ All notable changes to this project will be documented in this file.
|
|||||||
|
|
||||||
## Versions
|
## Versions
|
||||||
|
|
||||||
|
### [3.15.0] 2024-08-21 FDN, DSK, and other fixes
|
||||||
|
|
||||||
|
Major thanks to @Horsty80 for the PR and patience! Thanks to @HeliumOctahelide as well for contributions.
|
||||||
|
|
||||||
|
* **Added:** Duskmourne set symbol (DSK) ([#232](https://github.com/andrewgioia/keyrune/issues/232))
|
||||||
|
* **Added:** Foundations set symbol (FND) ([#233](https://github.com/andrewgioia/keyrune/issues/233))
|
||||||
|
* **Added:** Map to MH2 retro frame set code ([#239](https://github.com/andrewgioia/keyrune/pull/239))
|
||||||
|
* **Fixed:** BLB now correctly displayed, no longer showing BLC ([#234](https://github.com/andrewgioia/keyrune/issues/234))
|
||||||
|
* **Changed:** Development dependendies in `package.json` for lessc, sass, and clean-css.
|
||||||
|
* **Added:** New contributing guide beginnings
|
||||||
|
|
||||||
### [3.14.1] 2024-03-04 Fixes docs for BIG, fixes .ttf for embedding
|
### [3.14.1] 2024-03-04 Fixes docs for BIG, fixes .ttf for embedding
|
||||||
|
|
||||||
* **Fixed:** Moved BIG to Expansions in docs ([#227](https://github.com/andrewgioia/keyrune/issues/227))
|
* **Fixed:** Moved BIG to Expansions in docs ([#227](https://github.com/andrewgioia/keyrune/issues/227))
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# Keyrune v3.14.0
|
# Keyrune v3.15.0
|
||||||
|
|
||||||
## The Magic: the Gathering set symbol font!
|
## The Magic: the Gathering set symbol font!
|
||||||
|
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "keyrune",
|
"name": "keyrune",
|
||||||
"homepage": "http://keyrune.andrewgioia.com",
|
"homepage": "http://keyrune.andrewgioia.com",
|
||||||
"version": "3.14.1",
|
"version": "3.15.0",
|
||||||
"authors": [
|
"authors": [
|
||||||
"Andrew Gioia <andrew@gioia.email>"
|
"Andrew Gioia <andrew@gioia.email>"
|
||||||
],
|
],
|
||||||
|
@ -1,25 +1,25 @@
|
|||||||
# Generate CSS
|
# Generate CSS
|
||||||
|
|
||||||
> exemple with the set icon of the set "Fondation" (FDN)
|
> Example with the set icon of the set "Foundation" (FDN)
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
Generate the CSS file with the following command:
|
Generate the CSS files with the following commands:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm run lessmin && npm run sassmin
|
npm run less && npm run lessmin
|
||||||
```
|
```
|
||||||
or for debug purpose you can run
|
If you prefer to use the Sass source, run these instead:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm run less && npm run sass
|
npm run sass && npm run sassmin
|
||||||
```
|
```
|
||||||
|
|
||||||
2 files will be generated in the `css` folder: `keyrune.css` and `keyrune.min.css`.
|
2 files will be generated in the `css` folder: `keyrune.css` and `keyrune.min.css`.
|
||||||
|
|
||||||
![generate-css](./images/generate-css.png)
|
![generate-css](./images/generate-css.png)
|
||||||
|
|
||||||
Yaay 🎉 you have generate the CSS file! Now you can use the new icon in the website. Follow the [Usage inside README.md](../README.md#usage)
|
Yaay 🎉 you have generated the CSS files! Now you can use the new icon(s) that were added, if any. Follow the [Usage inside README.md](../README.md#usage)
|
||||||
|
|
||||||
---
|
---
|
||||||
**Go to the next step: [Update the documentation](./UpdateDocumentation.md)**
|
**Go to the next step: [Update the documentation](./UpdateDocumentation.md)**
|
||||||
|
@ -1,20 +1,26 @@
|
|||||||
# Update Codebase
|
# Update Codebase
|
||||||
|
|
||||||
> exemple with the set icon of the set "Fondation" (FDN)
|
> Example with the set icon of the set "Foundation" (FDN)
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
You need to have `lessc` and `sass` installed on your computer.
|
You need to have `lessc` or `sass` installed on your computer.
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
### Updating Sass source
|
||||||
|
|
||||||
1. Open the `sass/_variables.scss` file in the repository.
|
1. Open the `sass/_variables.scss` file in the repository.
|
||||||
|
|
||||||
2. Add the new set icon in the `@keyrune-icons` list. (You can see that i add the short code `fdn` and the unicode character `1f31f`)
|
2. Add the new set icon in the `@keyrune-icons` list. (You can see that i add the short code `fdn` and the unicode character `1f31f`)
|
||||||
```diff
|
```diff
|
||||||
+ ("Foundations", "fdn", "\1f31f"),
|
+ ("Foundations", "fdn", "\1f31f"),
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Updating Less source
|
||||||
|
|
||||||
3. Open the `less/icons.less` file in the repository.
|
3. Open the `less/icons.less` file in the repository.
|
||||||
|
|
||||||
4. Add the new set icon in the `@keyrune-icons` list. (You can see that i add the short code `fdn` and the unicode character `1f31f`)
|
4. Add the new set icon in the `@keyrune-icons` list. (You can see that i add the short code `fdn` and the unicode character `1f31f`)
|
||||||
```diff
|
```diff
|
||||||
+ .@{ss-prefix}-fdn:before { content: "\1f31f"; } // Foundation
|
+ .@{ss-prefix}-fdn:before { content: "\1f31f"; } // Foundation
|
||||||
|
@ -1,12 +1,12 @@
|
|||||||
# Update Fonts
|
# Update Fonts
|
||||||
|
|
||||||
> exemple with the set icon of the set "Fondation" (FDN)
|
> Example with the set icon of the set "Foundation" (FDN)
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
1. Search for the icon you want to add (from scryfall.com: https://svgs.scryfall.io/sets/fdn.svg) and download it (inspect DOM and copy/paste in a blank file). Save it in a temporary folder in your desktop.
|
1. Search for the icon you want to add (from scryfall.com: https://svgs.scryfall.io/sets/fdn.svg) and download it (inspect DOM and copy/paste in a blank file). Save it in a temporary folder in your desktop.
|
||||||
|
|
||||||
2. On icomoon, click on the "Import Icons" button. Select the previously downloaded icon. It will be added in a "Untilited Set".
|
2. In Icomoon, click on the "Import Icons" button. Select the previously downloaded icon. It will be added in a "Untilited Set".
|
||||||
|
|
||||||
![import-icon](./images/import-icon.png)
|
![import-icon](./images/import-icon.png)
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user