From 3f56011b98e7ec363e8df99ba629b2ee5a73e0f7 Mon Sep 17 00:00:00 2001 From: galabovaa Date: Mon, 10 Jun 2024 18:17:53 +0100 Subject: [PATCH] shell --- README.md | 12 ++++++------ cmake/README.md | 14 +++++++------- docs/src/executable.md | 4 ++-- docs/src/interfaces/csharp.md | 2 +- docs/src/interfaces/python/index.md | 2 +- docs/src/options/intro.md | 2 +- nuget/README.md | 4 ++-- 7 files changed, 20 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index bd23561bab..85dc406a99 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ Documentation is available at https://ergo-code.github.io/HiGHS/. HiGHS uses CMake as build system, and requires at least version 3.15. To generate build files in a new subdirectory called 'build', run: -```sh +```shell cmake -S . -B build cmake --build build ``` @@ -72,7 +72,7 @@ This installs the executable `bin/highs` and the library `lib/highs`. To test whether the compilation was successful, change into the build directory and run -```sh +```shell ctest ``` More details on building with CMake can be found in `HiGHS/cmake/README.md`. @@ -134,7 +134,7 @@ See https://ergo-code.github.io/HiGHS/stable/installation/#Precompiled-Binaries. HiGHS can read MPS files and (CPLEX) LP files, and the following command solves the model in `ml.mps` -```sh +```shell highs ml.mps ``` #### Command line options @@ -181,13 +181,13 @@ We are happy to give a reasonable level of support via email sent to highsopt@gm The python package `highspy` is a thin wrapper around HiGHS and is available on [PyPi](https://pypi.org/project/highspy/). It can be easily installed via `pip` by running -```sh +```shell $ pip install highspy ``` Alternatively, `highspy` can be built from source. Download the HiGHS source code and run -```sh +```shell pip install . ``` from the root directory. @@ -207,7 +207,7 @@ The nuget package Highs.Native is on https://www.nuget.org, at https://www.nuget It can be added to your C# project with `dotnet` -```bash +```shell dotnet add package Highs.Native --version 1.7.0 ``` diff --git a/cmake/README.md b/cmake/README.md index 840ac83ff5..4cb04ac682 100644 --- a/cmake/README.md +++ b/cmake/README.md @@ -123,26 +123,26 @@ cmake --install build By default, CMake builds the debug version of the binaries. These are generated in a directory `Debug`. To build a release version, add the option `--config Release` -```bash +```shell cmake -S . -B build cmake --build build --config Release ``` It is also possible to specify a specific Visual studio version to build with: -```bash +```shell cmake -G "Visual Studio 17 2022" -S . -B build cmake --build build ``` When building under Windows, some extra options are available. One is building a 32 bit version or a 64 bit version. The default build is 64 bit. To build 32 bit, the following commands can be used from the `HiGHS/` directory: -```bash +```shell cmake -A Win32 -S . -B buildWin32 cmake --build buildWin32 ``` Another thing specific for windows is the calling convention, particularly important for the HiGHS dynamic library (dll). The default calling convention in windows is cdecl calling convention, however, dlls are most often compiled with stdcall. Most applications which expect stdcall, can't access dlls with cdecl and vice versa. To change the default calling convention from cdecl to stdcall the following option can be added -```bash +```shell cmake -DSTDCALL=ON -S . -B build cmake --build build ``` @@ -163,12 +163,12 @@ before running `cmake --build `
For example, to generate build files in a new subdirectory called 'build', run: -```sh +```shell cmake -S. -Bbuild ``` and then build with: -```sh +```shell cmake --build build ``` @@ -187,7 +187,7 @@ Following is a list of available options: diff --git a/docs/src/executable.md b/docs/src/executable.md index d18d46ab63..d9f1777555 100644 --- a/docs/src/executable.md +++ b/docs/src/executable.md @@ -6,7 +6,7 @@ For convenience, the executable is assumed to be `bin/highs`. The model given by the MPS file `model.mps` is solved by the command: -```bash +```shell $ bin/highs model.mps ``` @@ -19,7 +19,7 @@ When HiGHS is run from the command line, some fundamental option values may be specified directly. Many more may be specified via a file. Formally, the usage is: -```bash +```shell $ bin/highs --help HiGHS options Usage: diff --git a/docs/src/interfaces/csharp.md b/docs/src/interfaces/csharp.md index 0455946d8f..884c3a419e 100644 --- a/docs/src/interfaces/csharp.md +++ b/docs/src/interfaces/csharp.md @@ -16,7 +16,7 @@ The nuget package Highs.Native is on https://www.nuget.org, at https://www.nuget It can be added to your C# project with `dotnet` -```bash +```shell dotnet add package Highs.Native --version 1.7.0 ``` diff --git a/docs/src/interfaces/python/index.md b/docs/src/interfaces/python/index.md index 82851f2e4b..991b2cae32 100644 --- a/docs/src/interfaces/python/index.md +++ b/docs/src/interfaces/python/index.md @@ -6,7 +6,7 @@ HiGHS is available as `highspy` on [PyPi](https://pypi.org/project/highspy/). If `highspy` is not already installed, run: -```bash +```shell $ pip install highspy ``` diff --git a/docs/src/options/intro.md b/docs/src/options/intro.md index 686d529a43..ff33cae234 100644 --- a/docs/src/options/intro.md +++ b/docs/src/options/intro.md @@ -15,7 +15,7 @@ options file. A sample options file, giving documentation of all the options is written to the console by the command: -```bash +```shell $ bin/highs --options_file="" ``` diff --git a/nuget/README.md b/nuget/README.md index 9f7cd71d99..879c409c03 100644 --- a/nuget/README.md +++ b/nuget/README.md @@ -6,7 +6,7 @@ The nuget package Highs.Native is on https://www.nuget.org, at https://www.nuget It can be added to your C# project with `dotnet` -```bash +```shell dotnet add package Highs.Native --version 1.7.0 ``` @@ -29,7 +29,7 @@ cmake -S. -Bbuild -DCSHARP=ON -DBUILD_DOTNET=ON Then, from `build/dotnet/Highs.Native`, run -```bash +```shell dotnet pack -c Release /p:Version=$version ```