Skip to content

Commit b11616f

Browse files
committed
Update README
1 parent 2b9ee1c commit b11616f

File tree

1 file changed

+16
-17
lines changed

1 file changed

+16
-17
lines changed

README.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
2+
[![Swift CI](https://github.com/mrLSD/llvm-api-swift/actions/workflows/swift.yaml/badge.svg)](https://github.com/mrLSD/llvm-api-swift/actions/workflows/swift.yaml)
3+
14
# `llvm-api-swift`
25

36
`llvm-api-swift` is a library representing Swift LLVM API, a pure Swift interface to the [LLVM API](https://llvm.org/docs/) and its associated libraries.
@@ -14,22 +17,23 @@ At the same time adhering to the principles of a safety and reliability implemen
1417

1518

1619
### Requirements
20+
1721
- Supported OS: MacOS 12.0 or above
22+
1823
- Swift lang: 5.9 or above
1924

20-
- Install LLVM:
25+
- Install latest LLVM:
2126
```
2227
brew install llvm
2328
```
29+
2430
- Set Environment variables, that provided during `brew` llvm install
25-
- initializes `pkg-config`:
26-
```
27-
./utils/make-pkg-config.swift
28-
```
2931

30-
**NOTE:** Every time, when LLVM is updated or installed new version should be run `pkg-config` step.
32+
- You don't need additional configurations like `pkg-config` files, if your LLVM installation is correct and you successfully set environment variable.
33+
34+
:arrow_right: If you have problems, just check [Troubleshooting](#troubleshooting).
3135

32-
### Supported LLVM version
36+
### Supported LLVM versions
3337

3438
- [x] v17.0
3539
- [x] v18.0
@@ -38,22 +42,17 @@ brew install llvm
3842
### Troubleshooting
3943

4044
If `LLVM-C` head files during compilation doesn't found, make sure that you are:
41-
- installed LLVM
45+
46+
- installed LLVM correctly
4247
```
4348
llc --version
4449
```
50+
4551
- Set environment variables for your terminal (for example in `.zshrc`). To get instruction about variables run:
4652
```
4753
brew info llvm
4854
```
49-
- run pkg-config utility:
50-
```
51-
./utils/make-pkg-config.swift
52-
```
53-
- if utility doesn't have access right to run:
54-
```
55-
chmod +x ./utils/make-pkg-config.swift
56-
./utils/make-pkg-config.swift
57-
```
55+
56+
- To get more insights take a look current project [Github CI config](.github/workflows/swift.yaml).
5857

5958
### LICENS: [MIT](LICENSE)

0 commit comments

Comments
 (0)