Skip to content

Commit e84575b

Browse files
committed
keycap information
1 parent ea77ab4 commit e84575b

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,12 +72,17 @@ Q-Pro-Series/
7272
Q1 Pro/ — Wireless Q-series hardware files
7373
K-Pro-Series/
7474
K6 Pro/ — Keyboard case, plate, stabilizer, full model
75+
K8 Pro/ — Example model folder with `K8-Pro-Keycap.stp`
7576
V-Max-Series/
7677
V1 Max/ — Tri-mode keyboard hardware files
78+
K-Max-Series/
79+
K8 Max/ — Example model folder with `K8-Max-Keycap.stp`
80+
K-HE-Series/
81+
K2 HE/ — Example model folder with Cherry and OSA keycap STEP files
7782
Mice/
7883
M1/ — Shell and full model
7984
Keycap Profiles/
80-
OSA Profile/ — Profile-specific keycap geometry
85+
OSA Profile/ — Reference documentation for profile shapes and terminology
8186
KSA Profile/
8287
docs/
8388
file-format-guide.md — How to open and edit these files

docs/getting-started.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,12 @@ This guide is for anyone opening the repository for the first time and wanting a
77
Start by choosing the kind of hardware you want to explore:
88
- `Q-Series/`, `Q-Pro-Series/`, `Q-HE-Series/`, `K-Pro-Series/`, `K-Max-Series/`, `K-HE-Series/`, `V-Max-Series/`, `P-HE-Series/`, and `L-Series/` for keyboard models and related parts
99
- `Mice/` for mouse shell and full-model files
10-
- `Keycap Profiles/` for profile-specific keycap geometry
10+
- `Keycap Profiles/` for reference documentation about profile shapes and naming
11+
12+
If you want actual keycap STEP files, open a model directory that includes them, such as:
13+
- `K-Pro-Series/K8 Pro/` for `K8-Pro-Keycap.stp`
14+
- `K-Max-Series/K8 Max/` for `K8-Max-Keycap.stp`
15+
- `K-HE-Series/K2 HE/` for Cherry-profile and OSA keycap STEP files
1116

1217
If you are just browsing, start with a single model instead of the whole repository.
1318

0 commit comments

Comments
 (0)