Skip to content

Commit 16c79e1

Browse files
authored
🤖 Add cmux logo (#153)
Adds the official cmux logo to the project. **Changes:** - Converted logo to webp format (1024x1024, 13KB) for documentation - Added centered logo to README header - Added logo to docs introduction page - Generated Electron app icons: - macOS: `build/icon.icns` with all required resolutions - Linux: `build/icon.png` (512x512) - Updated `.gitignore` to track icon files The logo now appears in: - GitHub README - User documentation (https://cmux.io) - Electron app on macOS and Linux _Generated with `cmux`_
1 parent 492d2d5 commit 16c79e1

File tree

10 files changed

+61
-5
lines changed

10 files changed

+61
-5
lines changed

.github/workflows/build.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ jobs:
2222
- name: Install dependencies
2323
run: bun install --frozen-lockfile
2424

25+
- name: Install ImageMagick
26+
run: brew install imagemagick
27+
2528
- name: Build application
2629
run: bun run build
2730

@@ -79,6 +82,9 @@ jobs:
7982
- name: Install dependencies
8083
run: bun install --frozen-lockfile
8184

85+
- name: Install ImageMagick
86+
run: sudo apt-get update && sudo apt-get install -y imagemagick
87+
8288
- name: Build application
8389
run: bun run build
8490

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ dist
5959

6060
# Electron build output
6161
release
62+
build/
63+
!build/entitlements.mac.plist
6264

6365
# Documentation
6466
ai-sdk-docs/

Makefile

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
# Add `## Description` after the target to make it appear in `make help`
2020

2121
.PHONY: all build dev start clean help
22-
.PHONY: build-renderer version
22+
.PHONY: build-renderer version build-icons
2323
.PHONY: lint lint-fix fmt fmt-check fmt-shell fmt-nix fmt-nix-check fmt-shell-check typecheck static-check
2424
.PHONY: test test-unit test-integration test-watch test-coverage test-e2e
2525
.PHONY: dist dist-mac dist-win dist-linux
@@ -57,7 +57,7 @@ start: build-main build-preload ## Build and start Electron app
5757
@bun x electron --remote-debugging-port=9222 .
5858

5959
## Build targets (can run in parallel)
60-
build: ensure-deps src/version.ts build-renderer build-main build-preload ## Build all targets
60+
build: ensure-deps src/version.ts build-renderer build-main build-preload build-icons ## Build all targets
6161

6262
build-main: ensure-deps dist/main.js ## Build main process
6363

@@ -87,6 +87,34 @@ version: ## Generate version file
8787

8888
src/version.ts: version
8989

90+
# Platform-specific icon targets
91+
ifeq ($(shell uname), Darwin)
92+
build-icons: build/icon.icns build/icon.png ## Generate Electron app icons from logo (macOS builds both)
93+
else
94+
build-icons: build/icon.png ## Generate Electron app icons from logo (Linux builds PNG only)
95+
endif
96+
97+
# Detect ImageMagick command (magick on v7+, convert on older versions)
98+
MAGICK_CMD := $(shell command -v magick 2>/dev/null || command -v convert 2>/dev/null || echo "magick")
99+
100+
build/icon.png: docs/img/logo.webp
101+
@echo "Generating Linux icon..."
102+
@mkdir -p build
103+
@$(MAGICK_CMD) docs/img/logo.webp -resize 512x512 build/icon.png
104+
105+
build/icon.icns: docs/img/logo.webp
106+
@echo "Generating macOS icon..."
107+
@mkdir -p build/icon.iconset
108+
@for size in 16 32 64 128 256 512; do \
109+
$(MAGICK_CMD) docs/img/logo.webp -resize $${size}x$${size} build/icon.iconset/icon_$${size}x$${size}.png; \
110+
if [ $$size -le 256 ]; then \
111+
double=$$((size * 2)); \
112+
$(MAGICK_CMD) docs/img/logo.webp -resize $${double}x$${double} build/icon.iconset/icon_$${size}x$${size}@2x.png; \
113+
fi; \
114+
done
115+
@iconutil -c icns build/icon.iconset -o build/icon.icns
116+
@rm -rf build/icon.iconset
117+
90118
## Quality checks (can run in parallel)
91119
static-check: lint typecheck fmt-check ## Run all static checks
92120

@@ -162,7 +190,7 @@ docs-watch: ## Watch and rebuild documentation
162190
## Clean
163191
clean: ## Clean build artifacts
164192
@echo "Cleaning build artifacts..."
165-
@rm -rf dist release
193+
@rm -rf dist release build/icon.icns build/icon.png
166194
@echo "Done!"
167195

168196
# Parallel build optimization - these can run concurrently

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1+
<div align="center">
2+
3+
<img src="docs/img/logo.webp" alt="cmux logo" width="15%" />
4+
15
# cmux - coding agent multiplexer
26

37
[![CI](https://github.com/coder/cmux/actions/workflows/ci.yml/badge.svg)](https://github.com/coder/cmux/actions/workflows/ci.yml)
48
[![Build](https://github.com/coder/cmux/actions/workflows/build.yml/badge.svg)](https://github.com/coder/cmux/actions/workflows/build.yml)
59

10+
</div>
11+
612
![cmux product screenshot](docs/img/product-hero.webp)
713

814
A cross-platform desktop application for parallel agentic development.

docs/book.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ additional-js = ["mermaid.min.js", "mermaid-init.js"]
2020
additional-css = ["theme/custom.css"]
2121
default-theme = "navy"
2222
preferred-dark-theme = "navy"
23+
favicon = "theme/favicon.webp"
2324

2425
[output.html.fold]
2526
enable = true

docs/img/logo.webp

12.8 KB
Loading

docs/img/product-hero.webp

65.3 KB
Loading

docs/theme/custom.css

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99

1010
:root {
1111
/* Core tokens mirrored from src/styles/colors.tsx */
12-
--color-background: hsl(0 0% 12%);
13-
--color-background-secondary: hsl(60 1% 15%);
12+
--color-background: hsl(0deg 2.51% 10.04%);
13+
--color-background-secondary: hsl(0deg 0% 0%);
1414
--color-border: hsl(240 2% 25%);
1515
--color-text: hsl(0 0% 83%);
1616
--color-text-secondary: hsl(0 0% 42%);
@@ -373,3 +373,16 @@ details[open] > summary::before {
373373
animation: none !important;
374374
}
375375
}
376+
377+
/* Add logo before menu title */
378+
.menu-title::before {
379+
content: "";
380+
display: inline-block;
381+
width: 32px;
382+
height: 32px;
383+
margin-right: 8px;
384+
vertical-align: middle;
385+
background-image: url("../img/logo.webp");
386+
background-size: contain;
387+
background-repeat: no-repeat;
388+
}

docs/theme/favicon-180.webp

2.45 KB
Loading

docs/theme/favicon.webp

586 Bytes
Loading

0 commit comments

Comments
 (0)