Skip to content

Commit

Permalink
Mention Polyhedra wrapper in README
Browse files Browse the repository at this point in the history
  • Loading branch information
blegat committed Oct 6, 2023
1 parent 4a01e22 commit df07706
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@
|:-------------:|:-------------:|:---------:|:-------:|:-------:|
|[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaPolyhedra.github.io/XPORTA.jl/dev) | [![Coverage Status](https://coveralls.io/repos/github/JuliaPolyhedra/XPORTA.jl/badge.svg?branch=main)](https://coveralls.io/github/JuliaPolyhedra/XPORTA.jl?branch=main)[![codecov](https://codecov.io/gh/JuliaPolyhedra/XPORTA.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/JuliaPolyhedra/XPORTA.jl) | [![Linux/Mac Build Status](https://travis-ci.org/JuliaPolyhedra/XPORTA.jl.svg?branch=main)](https://travis-ci.org/github/JuliaPolyhedra/XPORTA.jl) | [![Windows Build status](https://ci.appveyor.com/api/projects/status/2kjsbavtulwhsamu?svg=true)](https://ci.appveyor.com/project/bdoolittle/xporta-jl) | [![FreeBSD Build Status](https://api.cirrus-ci.com/github/JuliaPolyhedra/XPORTA.jl.svg)](https://cirrus-ci.com/github/JuliaPolyhedra/XPORTA.jl) |

It has two components:

- a thin wrapper around the complete PORTA API
- an interface to [Polyhedra](https://github.com/JuliaPolyhedra/Polyhedra.jl)

## Documentation

* XPORTA.jl documentation: [JuliaPolyhedra.github.io/XPORTA.jl/dev/](https://JuliaPolyhedra.github.io/XPORTA.jl/dev/)
Expand All @@ -16,6 +21,16 @@

PORTA and XPORTA.jl are licensed under the GNU General Public License (GPL) v2.0.

## Use with Polyhedra

To use XPORTA with Polyhedra, use `XPORTA.Library`:

```julia
using Polyhedra, XPORTA
h = hrep(...)
p = polyhedron(h, XPORTA.Library())
```

## Acknowledgments

Development of XPORTA.jl was made possible by the advisory of Dr. Eric Chitambar
Expand Down

0 comments on commit df07706

Please sign in to comment.