From 30efbd6ac1271167921a417863c37f3c798db4a3 Mon Sep 17 00:00:00 2001 From: Marius Merschformann Date: Mon, 4 Mar 2024 03:41:04 +0100 Subject: [PATCH 1/2] Provide more info in readme --- README.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3ec2f95..0005dbc 100644 --- a/README.md +++ b/README.md @@ -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 nextroute 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/nextroute). +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). From 32494bf1eb88754bda5bf1b02556b6213ab6122b Mon Sep 17 00:00:00 2001 From: Marius Merschformann Date: Mon, 4 Mar 2024 03:42:52 +0100 Subject: [PATCH 2/2] Fix copy/paste error --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0005dbc..5d97da8 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ ## License -Please note that nextroute is provided as _source-available_ software (not +Please note that go-highs is provided as _source-available_ software (not _open-source_). For further information, please refer to the [LICENSE](./LICENSE) file. @@ -21,7 +21,7 @@ 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/nextroute). +[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: