Skip to content

Commit 4f58329

Browse files
committed
Document CompText brand assets
1 parent 6197ca3 commit 4f58329

1 file changed

Lines changed: 47 additions & 0 deletions

File tree

assets/README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# CompText CLI Brand Assets
2+
3+
This directory contains lightweight SVG assets for the CompText CLI repository.
4+
5+
## Files
6+
7+
```text
8+
assets/logo.svg Full wordmark logo
9+
assets/mark.svg Square icon / compact mark
10+
assets/banner.svg README banner
11+
assets/social-preview.svg GitHub social preview source artwork
12+
```
13+
14+
## GitHub Social Preview
15+
16+
GitHub repository social preview images are configured in the repository settings, not from README markdown.
17+
18+
Use this asset as the source artwork:
19+
20+
```text
21+
assets/social-preview.svg
22+
```
23+
24+
For best GitHub compatibility, export it to PNG at:
25+
26+
```text
27+
1280x640
28+
```
29+
30+
Then upload it under:
31+
32+
```text
33+
Repository Settings -> Social preview -> Edit
34+
```
35+
36+
## Brand Lines
37+
38+
```text
39+
Models are providers. Context is the product.
40+
Compress the noise, preserve the proof.
41+
```
42+
43+
## Notes
44+
45+
- Assets are plain SVG and do not require external fonts.
46+
- Keep the logo simple, readable, and terminal-oriented.
47+
- Do not imply production, enterprise, compliance, certification, or guaranteed safety claims.

0 commit comments

Comments
 (0)