Skip to content

Commit 7d931e5

Browse files
blegatbdoolittle
andauthored
Mention Polyhedra wrapper in README (#7)
* Mention Polyhedra wrapper in README * Update README.md Co-authored-by: Brian Doolittle <[email protected]> * Update README.md --------- Co-authored-by: Brian Doolittle <[email protected]>
1 parent 88a450b commit 7d931e5

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,12 @@
22

33
*A julia wrapper for the [PORTA](http://porta.zib.de/) polyhedral analysis software.*
44

5-
| Documentation | Test Coverage | Linux/Mac | Windows | FreeBSD |
6-
|:-------------:|:-------------:|:---------:|:-------:|:-------:|
7-
|[![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) |
5+
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaPolyhedra.github.io/XPORTA.jl/dev)[![Test Status](https://github.com/JuliaPolyhedra/XPORTA.jl/actions/workflows/run_tests.yml/badge.svg)](https://github.com/JuliaPolyhedra/XPORTA.jl/actions/workflows/run_tests.yml)
6+
7+
XPORTA provides two features:
8+
9+
- a thin wrapper around the complete PORTA API
10+
- an interface to [Polyhedra](https://github.com/JuliaPolyhedra/Polyhedra.jl)
811

912
## Documentation
1013

@@ -16,6 +19,16 @@
1619

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

22+
## Use with Polyhedra
23+
24+
To use XPORTA with Polyhedra, use `XPORTA.Library`:
25+
26+
```julia
27+
using Polyhedra, XPORTA
28+
h = hrep(...)
29+
p = polyhedron(h, XPORTA.Library())
30+
```
31+
1932
## Acknowledgments
2033

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

0 commit comments

Comments
 (0)