Skip to content

Commit

Permalink
polish
Browse files Browse the repository at this point in the history
  • Loading branch information
jiacai2050 committed Oct 16, 2024
1 parent abaf4a1 commit 5749bf5
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
[[https://github.com/jiacai2050/zig-cc/actions/workflows/ci.yml][https://github.com/jiacai2050/zig-cc/actions/workflows/ci.yml/badge.svg]]
[[https://github.com/jiacai2050/zig-cc/actions/workflows/zig.yml][https://github.com/jiacai2050/zig-cc/actions/workflows/zig.yml/badge.svg]]
[[https://github.com/jiacai2050/zig-cc/actions/workflows/release.yml][https://github.com/jiacai2050/zig-cc/actions/workflows/release.yml/badge.svg]]
[[https://pypi.org/project/zigcc][https://img.shields.io/pypi/v/zigcc]]
[[https://pypi.org/project/zigcc][https://img.shields.io/pypi/v/zigcc.svg]]

A util script that aims to ease use ~zig cc~ to compile C/C++/Rust/Go programs.

Expand All @@ -21,7 +21,7 @@ So this project was born, it will
- Ignore link args when =zig cc= throw errors, hopefully this will make compile successfully, WIP.
* Install
#+begin_src bash
pip install -U zigcc
pip3 install -U zigcc
#+end_src

This will install three executables:
Expand All @@ -34,8 +34,8 @@ This will install three executables:
* Use in GitHub Action
Adding a step to your workflow like this:
#+begin_src yaml
- name: Install ZigCC
uses: jiacai2050/zigcc@main
- name: Install zigcc
uses: jiacai2050/zigcc@v1
with:
zig-version: master
#+end_src
Expand All @@ -46,6 +46,6 @@ There some are env variable to config zigcc:
- =ZIGCC_FLAGS=, space separated flags, pass to zig cc. An example is set this to =-fno-sanitize=undefined= to disable sanitize since they may break your programs. See [[https://nathancraddock.com/blog/zig-cc-undefined-behavior/][Catching undefined behavior with zig cc]]
- =ZIGCC_BLACKLIST_FLAGS=, space separated flags, used to filter flags =zig cc= don't support, such as =-Wl,-dylib= otherwise you could see errors below
#+begin_src bash
= note: error: unsupported linker arg: -dylib
note: error: unsupported linker arg: -dylib
#+end_src
- =ZIGCC_VERBOSE= Set to =1= enable verbose logs.
2 changes: 1 addition & 1 deletion zigcc/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
import logging
import subprocess

__VERSION__ = '0.1.0'
__VERSION__ = '1.0.0'

UNKNOWN = 0
RUST = 1
Expand Down

0 comments on commit 5749bf5

Please sign in to comment.