From 3a7d6663b44842bb03d4e7aa700df44181827d50 Mon Sep 17 00:00:00 2001 From: Andrew Gioia Date: Wed, 21 Aug 2024 14:10:22 -0400 Subject: [PATCH] Slight updates to contributing docs, fixes version in a few places, adds to changelog --- CHANGELOG.md | 13 ++++++++++++- README.md | 2 +- bower.json | 2 +- contributing/GenerateCss.md | 12 ++++++------ contributing/UpdateCodebase.md | 10 ++++++++-- contributing/UpdateFonts.md | 4 ++-- 6 files changed, 30 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6acde90..f148bea 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,7 +9,18 @@ All notable changes to this project will be documented in this file. * Validate all class names to handle official set codes, MODO codes, and MTGJson/community fallbacks * Update this changelog for better formatting -## 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 diff --git a/README.md b/README.md index 96e0c2d..394a39f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Keyrune v3.14.0 +# Keyrune v3.15.0 ## The Magic: the Gathering set symbol font! diff --git a/bower.json b/bower.json index 987af48..e90e89b 100644 --- a/bower.json +++ b/bower.json @@ -1,7 +1,7 @@ { "name": "keyrune", "homepage": "http://keyrune.andrewgioia.com", - "version": "3.14.1", + "version": "3.15.0", "authors": [ "Andrew Gioia " ], diff --git a/contributing/GenerateCss.md b/contributing/GenerateCss.md index 4f28f68..f135781 100644 --- a/contributing/GenerateCss.md +++ b/contributing/GenerateCss.md @@ -1,25 +1,25 @@ # Generate CSS -> exemple with the set icon of the set "Fondation" (FDN) +> Example with the set icon of the set "Foundation" (FDN) ## Steps -Generate the CSS file with the following command: +Generate the CSS files with the following commands: ```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 -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`. ![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)** diff --git a/contributing/UpdateCodebase.md b/contributing/UpdateCodebase.md index d3f0e4e..3500fc3 100644 --- a/contributing/UpdateCodebase.md +++ b/contributing/UpdateCodebase.md @@ -1,20 +1,26 @@ # Update Codebase -> exemple with the set icon of the set "Fondation" (FDN) +> Example with the set icon of the set "Foundation" (FDN) ## Prerequisites -You need to have `lessc` and `sass` installed on your computer. +You need to have `lessc` or `sass` installed on your computer. ## Steps +### Updating Sass source + 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`) ```diff + ("Foundations", "fdn", "\1f31f"), ``` +### Updating Less source + 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`) ```diff + .@{ss-prefix}-fdn:before { content: "\1f31f"; } // Foundation diff --git a/contributing/UpdateFonts.md b/contributing/UpdateFonts.md index 6768918..ada0237 100644 --- a/contributing/UpdateFonts.md +++ b/contributing/UpdateFonts.md @@ -1,12 +1,12 @@ # Update Fonts -> exemple with the set icon of the set "Fondation" (FDN) +> Example with the set icon of the set "Foundation" (FDN) ## 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. -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)