Skip to content

Commit

Permalink
add badges
Browse files Browse the repository at this point in the history
  • Loading branch information
KristofferC authored Jan 20, 2021
1 parent 7a97fee commit cccd36a
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,18 @@
# AMGX.jl
# AMGX.jl

*AMGX in Julia*

| **Build Status** |
|:-------------------------------------------------------------------:|
| [![][buildkite-img]][buildkite-url] [![][codecov-img]][codecov-url] |

The AMGX.jl package provides an interface for using NVIDIA's [AMGX](https://github.com/NVIDIA/AMGX) library from the Julia language.

This package is still a work in progress but is usable.
[buildkite-img]: https://badge.buildkite.com/ce21dc6bf28e053c02c8c726ea0c65cc981a22ec2934e01e56.svg?branch=master
[buildkite-url]: https://buildkite.com/julialang/amgx-dot-jl

[codecov-img]: https://codecov.io/gh/JuliaGPU/AMGX.jl/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/JuliaGPU/AMGX.jl

## Installation

Expand All @@ -12,14 +22,13 @@ The package is installed using the Julia package manager:
using Pkg; Pkg.install(url ="https://github.com/JuliaComputing/AMGX.jl")
```

Currently, only prebuilt binaries are available for Linux, otherwise you need to have AMGX available
Currently, only prebuilt binaries are available for Linux, on other operating systems you need to have AMGX available
locally.

Before using the package, reading through the [official API reference docs for
AMGX](https://github.com/NVIDIA/AMGX/blob/main/doc/AMGX_Reference.pdf) is recommended.



## API


Expand Down

0 comments on commit cccd36a

Please sign in to comment.