Skip to content

Commit 962b70d

Browse files
committed
add branding
1 parent c85ed80 commit 962b70d

14 files changed

Lines changed: 242 additions & 6 deletions

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,3 +106,6 @@ lib/
106106

107107

108108
# End of https://www.gitignore.io/api/delphi,lazarus,freepascal
109+
110+
### Tools ###
111+
tools/

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
1-
# QRCodeGenLib4Pascal
2-
3-
[![Build Status](https://github.com/Xor-el/QRCodeGenLib4Pascal/actions/workflows/make.yml/badge.svg)](https://github.com/Xor-el/QRCodeGenLib4Pascal/actions/workflows/make.yml)
4-
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Xor-el/QRCodeGenLib4Pascal/blob/master/LICENSE)
5-
[![Delphi](https://img.shields.io/badge/Delphi-XE3%2B-red.svg)](https://www.embarcadero.com/products/delphi)
6-
[![FreePascal](https://img.shields.io/badge/FreePascal-3.0.0%2B-blue.svg)](https://www.freepascal.org/)
1+
<p align="center">
2+
<img src="assets/branding/logo.svg" width="160" alt="QRCodeGenLib4Pascal logo" />
3+
<h1 align="center">QRCodeGenLib4Pascal</h1>
4+
<p align="center">
5+
<a href="https://github.com/Xor-el/QRCodeGenLib4Pascal/actions/workflows/make.yml"><img src="https://github.com/Xor-el/QRCodeGenLib4Pascal/actions/workflows/make.yml/badge.svg" alt="Build Status"></a>
6+
<a href="https://github.com/Xor-el/QRCodeGenLib4Pascal/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License: MIT"></a>
7+
<a href="https://www.embarcadero.com/products/delphi"><img src="https://img.shields.io/badge/Delphi-XE3%2B-red.svg" alt="Delphi XE3+"></a>
8+
<a href="https://www.freepascal.org/"><img src="https://img.shields.io/badge/FreePascal-3.0.0%2B-blue.svg" alt="FreePascal 3.0.0+"></a>
9+
</p>
10+
</p>
11+
12+
---
713

814
**QRCodeGenLib4Pascal** is a Delphi/FreePascal port of [Fast-QR-Code-generator](https://www.nayuki.io/page/fast-qr-code-generator-library) by [Nayuki](https://www.nayuki.io/), providing an easy-to-use interface for generating QR Codes, released under the permissive [MIT License](LICENSE).
915

@@ -16,6 +22,7 @@
1622
- [Contributing](#contributing)
1723
- [Tip Jar](#tip-jar)
1824
- [License](#license)
25+
- [Branding](assets/branding/README.md)
1926

2027
## Features
2128

assets/branding/BRAND.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# QRCodeGenLib4Pascal — lightweight brand guide
2+
3+
## Primary mark
4+
5+
- **Default:** `logo.svg`**scan frame** around a **white QR tile**: cyan **corner brackets** (viewfinder) and a **6×6 module** pattern (stylized, not a real payload). Reads as **QR generation / encoding**, not a scanner app icon alone.
6+
- **Dark UI:** `logo-dark.svg` — same layout on a **near-black** badge, **slate** inner tile, **light** modules, **bright cyan** frame.
7+
8+
**QR Code** is a registered trademark of **DENSO WAVE INCORPORATED**. This mark is an original graphic for the library project; it does not imply endorsement by Denso Wave.
9+
10+
## Palette (default logo)
11+
12+
| Role | Hex | Notes |
13+
|------|-----|--------|
14+
| Badge top | `#0c4a6e` | Gradient start (diagonal). |
15+
| Badge bottom | `#0f172a` | Gradient end. |
16+
| Inner tile | `#f8fafc` | “Paper” behind modules. |
17+
| Scan frame | `#22d3ee` | 4 px stroke, rounded caps. |
18+
| Modules | `#0f172a` | 5 px squares, 2 px gap; centered in bracket opening. |
19+
20+
Dark variant uses `#0f172a``#020617`, tile `#1e293b`, frame `#67e8f9`, modules `#e2e8f0`.
21+
22+
**Banner background** (flat fill behind the logo in wide `export/*.png` social / OG assets): RGB **13, 74, 110** (`#0d4a6e`) — aligned with the default badge teal; +1 red vs `#0c4a6e` so the squircle rim is visible on composites.
23+
24+
## Typography (pairing)
25+
26+
The logo has **no embedded wordmark**. When setting type next to the mark:
27+
28+
- Prefer **clean sans-serif** system or UI fonts (e.g. Segoe UI, Inter, Source Sans 3).
29+
- **Do not** use Embarcadero’s proprietary Delphi logotype in a way that suggests a product bundle with this library.
30+
31+
## Clear space
32+
33+
Keep padding around the badge at least **1/4 of the mark’s width** (e.g. ~32 px clear space on a 128 px square canvas).
34+
35+
## Minimum size
36+
37+
- **Favicon / IDE:** readable at **16×16** when exported to ICO; prefer **32×32** or larger for clarity.
38+
- **README / docs:** **128–200 px** wide for the SVG or equivalent raster is typical.
39+
40+
## Correct use
41+
42+
- Scale **uniformly** (preserve aspect ratio).
43+
- Place on backgrounds with enough contrast (use `logo-dark.svg` on dark pages).
44+
- Prefer **SVG** for web; use **PNG** where required (some social crawlers).
45+
46+
## Incorrect use
47+
48+
- Do not **stretch** or **skew** the badge.
49+
- Do not **change hue** arbitrarily without updating this doc.
50+
- Do not **crop** away the rounded corners entirely.
51+
- Do not imply **QR Code trademark** ownership; attribute the standard where appropriate in docs.
52+
53+
## Wordmark
54+
55+
“QRCodeGenLib4Pascal” in plain text beside or below the mark is sufficient.

assets/branding/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# QRCodeGenLib4Pascal branding
2+
3+
This folder holds the **project logo** and derivative assets for README, social previews, and optional IDE package icons.
4+
5+
## Meaning
6+
7+
The mark is a **rounded badge** with a **scan-style frame** (corner brackets) around **QR modules** on a light tile. It suggests:
8+
9+
- **QR symbol generation** — encoding data into a QR matrix (library focus).
10+
- **Clarity** — readable at small sizes (favicon / package icon).
11+
12+
It is **not** the official QR Code logo and is **not** affiliated with Denso Wave. **QR Code** is a registered trademark of **DENSO WAVE INCORPORATED**.
13+
14+
## Files
15+
16+
| File | Use |
17+
|------|-----|
18+
| `logo.svg` | **Source of truth** (light UI / default README). |
19+
| `logo-dark.svg` | Dark backgrounds (docs, dark-themed pages). |
20+
| `BRAND.md` | Colors, clear space, minimum size, do / don’t. |
21+
| `export/*.png` | Raster exports (GitHub social 2:1, Open Graph, social header, square avatar). |
22+
| `icons/QRCodeGenLib4Pascal.ico` | Multi-resolution Windows icon for `.dproj` / `.lpi`. |
23+
24+
## License
25+
26+
The **library source code** is under the project [MIT License](../../LICENSE). The **logo files in this directory** are also released under the **MIT License** unless the repository maintainers specify otherwise; you may use them to refer to QRCodeGenLib4Pascal. Do not use them to misrepresent authorship or to imply certification by Denso Wave or Embarcadero.
27+
28+
## Regenerating PNG and ICO
29+
30+
If you change the SVG, regenerate rasters using one of:
31+
32+
- **Inkscape** (CLI): export PNG at the sizes listed in `export/README.md`.
33+
- **ImageMagick** 7+: `magick logo.svg -resize 512x512 export/logo-512.png` (and similar).
34+
35+
Exact filenames and pixel sizes are listed in `export/README.md`.

assets/branding/export/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Raster exports
2+
3+
PNG files in this folder are **generated from** `../logo.svg`.
4+
5+
| File | Size | Typical use |
6+
|------|------|-------------|
7+
| `og-1280x640.png` | 1280×640 | **GitHub social preview** (recommended; 2:1) |
8+
| `og-640x320.png` | 640×320 | GitHub social preview **minimum** (2:1) |
9+
| `og-1200x630.png` | 1200×630 | Open Graph / link previews |
10+
| `social-header-1500x500.png` | 1500×500 | Twitter/X-style header |
11+
| `logo-512.png` | 512×512 | Profile / square avatar |
12+
13+
Regenerate after SVG changes (see `../README.md`).
46.6 KB
Loading
28 KB
Loading
29.3 KB
Loading
9.15 KB
Loading
24.4 KB
Loading

0 commit comments

Comments
 (0)