Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ test:
fmt:
dune build @fmt --auto-promote

doc:
docs:
dune build @doc
rm -r docs
rm -rf docs
cp -r _build/default/_doc/_html docs
touch docs/.nojekyll

Expand Down
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,20 +51,21 @@ let () =
else print_endline "Oops, my problem is broken."
```

## Documentation
### Notes on solver interfaces

High level APIs have comments for odoc (or ocamldoc).
Generated docs can be found [online](https://ktahar.github.io/ocaml-lp/) or in [docs](docs) directory.
- Since lp-glpk is tested only on GLPK version 4.65 and 5+, something may fail on older versions.
- For lp-gurobi, compile your application with `-cclib -lgurobiXY` flags, where XY is the version of Gurobi (e.g. 91).

## Notes on GLPK interface
## Documentation

- To use this, compile your application with `-cclib -lglpk` flags.
- Since this is tested only on GLPK version 4.65 and 5+, something may fail on older versions.
High-level APIs have comments for odoc (or ocamldoc).
Generated docs can be found [online](https://ktahar.github.io/ocaml-lp/) or in [docs](docs) directory.

## Development Status

Original author isn't developing this heavily because basic features are completed.
However, bug-reports, requests, or patches are always welcome via GitHub [issues](https://github.com/ktahar/ocaml-lp/issues) and [pull requests](https://github.com/ktahar/ocaml-lp/pulls).
Development is not quite active now because basic features are completed.
However, there are several TODOs.
Bug-reports, requests, or patches are always welcome via GitHub [issues](https://github.com/ktahar/ocaml-lp/issues) and [pull requests](https://github.com/ktahar/ocaml-lp/pulls).

### Conformity to LP file format

Expand Down Expand Up @@ -99,4 +100,4 @@ Some references to LP file format.
- Manual of [GLPK](https://www.gnu.org/software/glpk/)

## License
MIT
[MIT](LICENSE.md)
2 changes: 0 additions & 2 deletions docs/lp-glpk/Lp_glp/Bnd/index.html

This file was deleted.

2 changes: 0 additions & 2 deletions docs/lp-glpk/Lp_glp/Dir/index.html

This file was deleted.

2 changes: 0 additions & 2 deletions docs/lp-glpk/Lp_glp/Iocp/Br/index.html

This file was deleted.

2 changes: 0 additions & 2 deletions docs/lp-glpk/Lp_glp/Iocp/Bt/index.html

This file was deleted.

2 changes: 0 additions & 2 deletions docs/lp-glpk/Lp_glp/Iocp/Pp/index.html

This file was deleted.

Loading