Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds more info to readme #2

Merged
merged 2 commits into from
Mar 4, 2024
Merged

Adds more info to readme #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
30efbd6
Provide more info in readme
merschformann Mar 4, 2024
32494bf
Fix copy/paste error
merschformann Mar 4, 2024
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
30 changes: 29 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,32 @@

# go-highs

HiGHS MIP modeling for Go.
**go-highs** provides a Go interface to the HiGHS linear programming solver.

## License

Please note that go-highs is provided as _source-available_ software (not
_open-source_). For further information, please refer to the [LICENSE](./LICENSE)
file.

## Usage

A first run can be done with the following command:

```bash
go run cmd/main.go -runner.input.path cmd/input.json
```

This will run the solver and output the result to the console.

In order to start a _new project_, please refer to the sample app in the
[community-apps repository](https://github.com/nextmv-io/community-apps/tree/develop/knapsack-gosdk).
If you have [Nextmv CLI](https://docs.nextmv.io/docs/platform/installation#nextmv-cli)
installed, you can create a new project with the following command:

```bash
nextmv community clone -a knapsack-gosdk
```

For further information on how to get started, features, deployment, etc.,
please refer to the [official documentation](https://docs.nextmv.io/docs/mixed-integer-programming).
Loading