Skip to content

Commit 47021ca

Browse files
committed
update README
1 parent e8b65cd commit 47021ca

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,32 @@
1-
# LIKWID.jl
1+
LIKWID.jl
2+
=========
3+
*Like I Knew What I am Doing*
4+
5+
LIKWID.jl is a Julia wrapper for [LIKWID](https://github.com/RRZE-HPC/likwid).
6+
7+
Installation
8+
------------
9+
10+
First install `likwid` following https://github.com/RRZE-HPC/likwid#download-build-and-install,
11+
and then use the Julia package manger to install `]add https://github.com/JuliaPerf/LIKWID.jl`.
12+
13+
Example
14+
-------
15+
16+
```julia
17+
using LIKWID
18+
using LinearAlgebra
19+
20+
A = rand(128, 64)
21+
B = rand(64, 128)
22+
C = zeros(128, 128)
23+
24+
LIKWID.Marker.startregion("matmul")
25+
mul!(C, A, B)
26+
LIKWID.Marker.stopregion("matmul")
27+
```
28+
29+
License
30+
-------
31+
32+
LIKWID.jl is licensed under the [MIT license](LICENSE).

0 commit comments

Comments
 (0)