Skip to content

Commit c8b5cc7

Browse files
committed
A few alterations to the README file
1 parent 7cdadc1 commit c8b5cc7

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Below are guides on how to use both interfaces of RelSys, which is available as
4949

5050
## Python (Linux)
5151

52-
We have created a Python module for Linux with `pybind11`. Head to the directory `Python/Linux/`, or run `wget https://github.com/areenberg/RelSys/blob/development/Python/Linux/relsys.cpython-310-x86_64-linux-gnu.so` to download the SO-file for the module.
52+
We have created a Python module for Linux with `pybind11`. Run `git clone https://github.com/areenberg/RelSys.git` and head to the directory `Python/Linux/` to get the SO-file for the module.
5353

5454
Start by importing the module,
5555

@@ -178,7 +178,7 @@ for queueIdx in range(4):
178178

179179
## Command-line Interface (Windows/Linux)
180180

181-
We have created a Command-Line Interface (CLI) for Windows and Linux, which is similar to the Python module in terms of features, inputs, and outputs. The CLI utilizes files to import the input parameters and export the results, ensuring a seamless integration. Windows users can head to the directory `Command-line Interface/Windows/`, or use `wget https://github.com/areenberg/RelSys/blob/master/Command-line%20Interface/Windows/relsys.exe` to download the EXE-file for the CLI. Similarly, Linux users can head to `Command-line Interface/Linux/` or use `wget https://github.com/areenberg/RelSys/blob/master/Command-line%20Interface/Linux/relsys.exe`.
181+
We have created a Command-Line Interface (CLI) for Windows and Linux, which is similar to the Python module in terms of features, inputs, and outputs. The CLI utilizes files to import the input parameters and export the results, ensuring a seamless integration. Run `git clone https://github.com/areenberg/RelSys.git`. Windows users can head to the directory `Command-line Interface/Windows/` to get the EXE-file for the CLI. Similarly, Linux users can head to `Command-line Interface/Linux/`.
182182

183183
The syntax for the CLI is `relsys [options]`. Use the `-help` flag to view all available options.
184184

@@ -222,13 +222,13 @@ Evaluate the model using simulation, and save the result in a semicolon-separate
222222
relsys -m simulation -arr arrivalRates.txt -ser serviceTimes.txt -cap capacity.txt -rel relocProbs.txt -prq preferred.txt -o results.csv
223223
```
224224

225-
### Windows Defender blocking the EXE-file
225+
### Windows Defender blocking the EXE-files
226226

227-
If you are a Windows user, you may encounter an issue where the Microsoft Defender SmartScreen blocks the EXE-file when you attempt to run the application. In this case, you will need to turn off SmartScreen to run the application. Alternatively, you can compile the EXE-file by downloading the source code from the `RelSys/` directory, removing the `PythonWrapper.cpp` file, and running the command `g++ -O3 -std=c++11 *.cpp -o relsys.exe`. This will enable you to run the application without any issues caused by SmartScreen.
227+
If you are a Windows user, you may encounter an issue where the Microsoft Defender SmartScreen blocks the EXE-file when you attempt to run the application. In this case, you will need to turn off SmartScreen to run the application. Alternatively, you can compile the EXE-file yourself by downloading the source code (`git clone https://github.com/areenberg/RelSys.git`), removing the `PythonWrapper.cpp` file, and running the command `g++ -O3 -std=c++11 *.cpp -o relsys.exe`. This will enable you to run the application without any issues caused by SmartScreen.
228228

229229
## C++
230230

231-
The following guide will show you how to use the C++ source code for evaluating a model. The directory `RelSys/` contains the complete source code for RelSys. Start by heading there. Create a `main.cpp` file.
231+
The following guide will show you how to use the C++ source code for evaluating a model. Run `git clone https://github.com/areenberg/RelSys.git`. The directory `RelSys/` contains the complete source code for RelSys. Start by heading here. Create a `main.cpp` file.
232232

233233
Write the following into the `main.cpp` file,
234234

0 commit comments

Comments
 (0)