Skip to content

Commit 2be0ed7

Browse files
committed
chore: rename to zig-toolchain.cmake
1 parent 38e4513 commit 2be0ed7

6 files changed

Lines changed: 31 additions & 96 deletions

File tree

.github/workflows/release.yml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -90,15 +90,15 @@ jobs:
9090
9191
\`\`\`bash
9292
# Download directly to your project
93-
curl -o zig.toolchain.cmake https://github.com/tayne3/zig.toolchain.cmake/releases/download/$TAG/zig.toolchain.cmake
93+
curl -o zig-toolchain.cmake https://github.com/tayne3/zig-toolchain.cmake/releases/download/$TAG/zig-toolchain.cmake
9494
\`\`\`
9595
9696
## 📝 Usage
9797
9898
\`\`\`bash
9999
# Cross-compile for Linux ARM64
100100
cmake -S . -B build -G Ninja \\
101-
-DCMAKE_TOOLCHAIN_FILE=zig.toolchain.cmake \\
101+
-DCMAKE_TOOLCHAIN_FILE=zig-toolchain.cmake \\
102102
-DCMAKE_SYSTEM_NAME=Linux \\
103103
-DCMAKE_SYSTEM_PROCESSOR=aarch64
104104
@@ -108,7 +108,7 @@ jobs:
108108
## 📚 Documentation
109109
110110
EOF
111-
echo "For complete usage instructions and examples, see the [README](https://github.com/tayne3/zig.toolchain.cmake#readme)." >> release_notes.md
111+
echo "For complete usage instructions and examples, see the [README](https://github.com/tayne3/zig-toolchain.cmake#readme)." >> release_notes.md
112112
echo "Generated release notes:"
113113
cat release_notes.md
114114
@@ -124,14 +124,14 @@ jobs:
124124
draft: false
125125
prerelease: ${{ steps.version.outputs.is_prerelease }}
126126

127-
- name: Upload zig.toolchain.cmake
127+
- name: Upload zig-toolchain.cmake
128128
uses: actions/upload-release-asset@v1
129129
env:
130130
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
131131
with:
132132
upload_url: ${{ steps.create_release.outputs.upload_url }}
133-
asset_path: zig.toolchain.cmake
134-
asset_name: zig.toolchain.cmake
133+
asset_path: zig-toolchain.cmake
134+
asset_name: zig-toolchain.cmake
135135
asset_content_type: text/plain
136136

137137
update-badges:
@@ -145,7 +145,7 @@ jobs:
145145
- name: Update release badge cache
146146
run: |
147147
# Trigger shield.io cache refresh for release badge
148-
curl -X POST "https://img.shields.io/github/v/release/tayne3/zig.toolchain.cmake?include_prereleases&label=release&logo=github&logoColor=white"
148+
curl -X POST "https://img.shields.io/github/v/release/tayne3/zig-toolchain.cmake?include_prereleases&label=release&logo=github&logoColor=white"
149149
echo "🔄 Badge cache refresh triggered"
150150
151151
notify-success:
@@ -158,6 +158,6 @@ jobs:
158158
steps:
159159
- name: Success notification
160160
run: |
161-
echo "🎉 Successfully released zig.toolchain.cmake ${{ needs.create-release.outputs.version }}"
162-
echo "📦 Download URL: https://github.com/tayne3/zig.toolchain.cmake/releases/download/${{ needs.create-release.outputs.tag }}/zig.toolchain.cmake"
163-
echo "🔗 Release page: https://github.com/tayne3/zig.toolchain.cmake/releases/tag/${{ needs.create-release.outputs.tag }}"
161+
echo "🎉 Successfully released zig-toolchain.cmake ${{ needs.create-release.outputs.version }}"
162+
echo "📦 Download URL: https://github.com/tayne3/zig-toolchain.cmake/releases/download/${{ needs.create-release.outputs.tag }}/zig-toolchain.cmake"
163+
echo "🔗 Release page: https://github.com/tayne3/zig-toolchain.cmake/releases/tag/${{ needs.create-release.outputs.tag }}"

.github/workflows/test.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ on:
44
push:
55
branches: [master, develop]
66
paths:
7-
- "zig.toolchain.cmake"
7+
- "zig-toolchain.cmake"
88
- "build.zig"
99
- "test/**"
1010
- ".github/workflows/test.yml"
1111
pull_request:
1212
branches: [master]
1313
paths:
14-
- "zig.toolchain.cmake"
14+
- "zig-toolchain.cmake"
1515
- "build.zig"
1616
- "test/**"
1717
workflow_dispatch:

README.md

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,61 @@
11
<div align="center">
22

3-
![zig.toolchain.cmake](assets/logo.svg)
3+
![zig-toolchain.cmake](assets/logo.svg)
44

5-
# zig.toolchain.cmake
5+
# zig-toolchain.cmake
66

7-
[![Release](https://img.shields.io/github/v/release/tayne3/zig.toolchain.cmake?include_prereleases&label=release&logo=github&logoColor=white)](https://github.com/tayne3/zig.toolchain.cmake/releases)
8-
[![Tag](https://img.shields.io/github/v/tag/tayne3/zig.toolchain.cmake?color=%23ff8936&style=flat-square&logo=git&logoColor=white)](https://github.com/tayne3/zig.toolchain.cmake/tags)
9-
[![Tests](https://github.com/tayne3/zig.toolchain.cmake/actions/workflows/test.yml/badge.svg)](https://github.com/tayne3/zig.toolchain.cmake/actions/workflows/test.yml)
7+
[![Release](https://img.shields.io/github/v/release/tayne3/zig-toolchain.cmake?include_prereleases&label=release&logo=github&logoColor=white)](https://github.com/tayne3/zig-toolchain.cmake/releases)
8+
[![Tag](https://img.shields.io/github/v/tag/tayne3/zig-toolchain.cmake?color=%23ff8936&style=flat-square&logo=git&logoColor=white)](https://github.com/tayne3/zig-toolchain.cmake/tags)
9+
[![Tests](https://github.com/tayne3/zig-toolchain.cmake/actions/workflows/test.yml/badge.svg)](https://github.com/tayne3/zig-toolchain.cmake/actions/workflows/test.yml)
1010
![CMake](https://img.shields.io/badge/CMake-3.14%2B-brightgreen?logo=cmake&logoColor=white)
1111

12-
**English** | [中文](README_zh.md)
13-
1412
</div>
1513

1614
A lightweight CMake toolchain file that enables cross-compilation of C/C++ projects using Zig, eliminating the need to install platform-specific GCC toolchains.
1715

1816
## Usage
1917

20-
**Requirements**
18+
**Requirements**:
2119

2220
- CMake 3.14+
23-
- Zig Compiler
21+
- Zig 0.15+
2422

25-
**Integration**
23+
**Integration**:
2624

27-
Download `zig.toolchain.cmake` to your project root or a `cmake/` subdirectory.
25+
Download `zig-toolchain.cmake` to your project root or a `cmake/` subdirectory.
2826

2927
```bash
30-
curl -o zig.toolchain.cmake https://github.com/tayne3/zig.toolchain.cmake/releases/download/v0.1.1/zig.toolchain.cmake
28+
curl -o zig-toolchain.cmake https://github.com/tayne3/zig-toolchain.cmake/releases/download/v0.1.3/zig-toolchain.cmake
3129
```
3230

33-
**Cross-Compilation**
31+
**Cross-Compilation**:
3432

3533
Use standard CMake variables for common targets, or specify `ZIG_TARGET` directly when you need precise ABI control (e.g., `musl` vs `gnu`).
3634

37-
*Compile for Linux ARM64:*
35+
_Compile for Linux ARM64:_
3836

3937
```bash
4038
cmake -S . -B build -G Ninja \
41-
-DCMAKE_TOOLCHAIN_FILE=zig.toolchain.cmake \
39+
-DCMAKE_TOOLCHAIN_FILE=zig-toolchain.cmake \
4240
-DCMAKE_SYSTEM_NAME=Linux \
4341
-DCMAKE_SYSTEM_PROCESSOR=aarch64
4442

4543
cmake --build build
4644
```
4745

48-
*Compile for Windows x64:*
46+
_Compile for Windows x64:_
4947

5048
```bash
5149
cmake -S . -B build -G Ninja \
52-
-DCMAKE_TOOLCHAIN_FILE=zig.toolchain.cmake \
50+
-DCMAKE_TOOLCHAIN_FILE=zig-toolchain.cmake \
5351
-DCMAKE_SYSTEM_NAME=Windows \
5452
-DCMAKE_SYSTEM_PROCESSOR=x86_64
5553
```
5654

57-
*Compile for Linux x86_64 (Musl/Static):*
55+
_Compile for Linux x86_64 (Musl/Static):_
5856

5957
```bash
6058
cmake -S . -B build -G Ninja \
61-
-DCMAKE_TOOLCHAIN_FILE=zig.toolchain.cmake \
59+
-DCMAKE_TOOLCHAIN_FILE=zig-toolchain.cmake \
6260
-DZIG_TARGET=x86_64-linux-musl
6361
```

README_zh.md

Lines changed: 0 additions & 63 deletions
This file was deleted.

build.zig

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
include_guard(GLOBAL)
22

3-
set(ZIG_TOOLCHAIN_VERSION "0.1.3")
3+
set(ZIG_TOOLCHAIN_VERSION "0.2.0")
44

55
if(CMAKE_GENERATOR MATCHES "Visual Studio")
66
message(FATAL_ERROR "Zig Toolchain: Visual Studio generator is not supported. Please use '-G Ninja' or '-G MinGW Makefiles'.")

0 commit comments

Comments
 (0)