Skip to content

Commit adfb045

Browse files
committed
Minor fixes in readme.
1 parent 8cbfa6c commit adfb045

File tree

3 files changed

+13
-11
lines changed

3 files changed

+13
-11
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# RunnerPost
22
RunnerPost is a C++ and Python interface for post-processing and profiling available optimization results.
33

4-
For plotting and visualization, Matplotlib library can be used. Also, LaTeX can be used to generate pdf files from generated tex files.
4+
For plotting and visualization, Matplotlib library is an option (TODO: script). Also, LaTeX can produce pdf files from tex files created during post-processing.
55

66

77
## Table of Contents
@@ -14,6 +14,7 @@ For plotting and visualization, Matplotlib library can be used. Also, LaTeX can
1414
- [Contact](#contact)
1515

1616

17+
1718
## Installation
1819

1920
To install RunnerPost, follow these steps:
@@ -23,19 +24,19 @@ To install RunnerPost, follow these steps:
2324
# Ensure you have Python 3.8 or higher
2425
```sh
2526
python --version
26-
````
27+
```
2728
or
2829
```sh
2930
python3 --version
3031
```
3132

32-
# If you don't have Python 3.8 or higher, you can download and install it from https://www.python.org/downloads/
33+
If you don't have Python 3.8 or higher, you can download and install it from https://www.python.org/downloads/
3334

3435
# You may want to create a virtual environment:
3536
```sh
3637
python3 -m venv venv
3738
source venv/bin/activate # On Windows use `venv\Scripts\activate`
38-
```sh
39+
```
3940

4041
# Install RunnerPost from TestPyPI:
4142
```sh
@@ -74,7 +75,7 @@ The selection files define the algorithms, problems, and outputs to be profiled.
7475

7576
### Python
7677

77-
# A simple sanity test using Data provided is available in the RunnerPost package:
78+
A simple sanity check using provided data is available in the RunnerPost package:
7879

7980
```python
8081
import RunnerPost

pythonInterface/README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# RunnerPost
22
RunnerPost is a C++ and Python interface for post-processing and profiling available optimization results.
33

4-
For plotting and visualization, Matplotlib library can be used. Also, LaTeX can be used to generate pdf files from generated tex files.
4+
For plotting and visualization, Matplotlib library is an option (TODO: script). Also, LaTeX can produce pdf files from tex files created during post-processing.
55

66

77
## Table of Contents
@@ -14,6 +14,7 @@ For plotting and visualization, Matplotlib library can be used. Also, LaTeX can
1414
- [Contact](#contact)
1515

1616

17+
1718
## Installation
1819

1920
To install RunnerPost, follow these steps:
@@ -23,19 +24,19 @@ To install RunnerPost, follow these steps:
2324
# Ensure you have Python 3.8 or higher
2425
```sh
2526
python --version
26-
````
27+
```
2728
or
2829
```sh
2930
python3 --version
3031
```
3132

32-
# If you don't have Python 3.8 or higher, you can download and install it from https://www.python.org/downloads/
33+
If you don't have Python 3.8 or higher, you can download and install it from https://www.python.org/downloads/
3334

3435
# You may want to create a virtual environment:
3536
```sh
3637
python3 -m venv venv
3738
source venv/bin/activate # On Windows use `venv\Scripts\activate`
38-
```sh
39+
```
3940

4041
# Install RunnerPost from TestPyPI:
4142
```sh
@@ -74,7 +75,7 @@ The selection files define the algorithms, problems, and outputs to be profiled.
7475

7576
### Python
7677

77-
# A simple sanity test using Data provided is available in the RunnerPost package:
78+
A simple sanity check using provided data is available in the RunnerPost package:
7879

7980
```python
8081
import RunnerPost

pythonInterface/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ authors = [
77
maintainers = [
88
{ name = "Christophe Tribes", email="[email protected]"},
99
]
10-
description = "RunnerPost Python interface and script"
10+
description = "RunnerPost Python interface and script for optimization post-processing"
1111
readme = { file = "README.md", content-type = "text/markdown"}
1212
requires-python = ">=3.8"
1313
classifiers = [

0 commit comments

Comments
 (0)