Skip to content

Commit aa5f245

Browse files
Address comments from Code Review
1 parent b97c436 commit aa5f245

File tree

3 files changed

+26
-9
lines changed

3 files changed

+26
-9
lines changed

pineappl_cli/README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,35 @@
55

66
This is the command-line interface (CLI) to [`pineappl`](https://crates.io/crates/pineappl).
77

8+
# Installation
9+
10+
The easiest way to install `pineappl` CLI is to download the pre-built binaries, for
11+
example using `pip`:
12+
13+
```sh
14+
pip install pineappl-cli
15+
```
16+
17+
or using the installation script (see this [guide](https://nnpdf.github.io/pineappl/docs/installation.html)
18+
for more details):
19+
20+
```sh
21+
curl --proto '=https' --tlsv1.2 -sSf https://nnpdf.github.io/pineappl/install-cli.sh | sh
22+
```
23+
24+
Alternatively, the CLI can be installed in a development mode by running the following
25+
command in the root of the repository:
26+
27+
```sh
28+
cargo install pineappl_cli
29+
```
30+
831
# Documentation
932

1033
A good starting point to learn what `pineappl` can do is the [CLI tutorial].
1134
For more information, see:
1235

13-
- [Installation](https://nnpdf.github.io/pineappl/docs/installation.html): installation
14-
instructions.
1536
- [CLI tutorial](https://nnpdf.github.io/pineappl/docs/cli-tutorial.html): a tutorial
1637
on how to use the `pineappl` CLI interface.
1738
- [CLI reference](https://nnpdf.github.io/pineappl/docs/cli-reference.html): a reference
1839
for the different parameters of the CLI.
19-
20-
# Installation
21-
22-
In a development mode, run `cargo install pineappl_cli` to install the `pineappl` binary.

pineappl_cli/pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ classifiers = [
2020
dynamic = ["version", "description", "readme", "authors", "license", "keywords"]
2121

2222
[project.urls]
23-
homepage = "https://nnpdf.github.io/pineappl/"
24-
documentation = "https://pineappl.readthedocs.io/"
23+
homepage = "https://nnpdf.github.io/pineappl/docs/"
24+
documentation = "https://nnpdf.github.io/pineappl/docs/cli-tutorial.html"
2525
changelog = "https://nnpdf.github.io/pineappl/CHANGELOG.html"
2626

2727
[tool.maturin]

pineappl_py/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ docs = [
3535
test = ["pytest", "pytest-cov"]
3636

3737
[project.urls]
38-
homepage = "https://nnpdf.github.io/pineappl/"
38+
homepage = "https://nnpdf.github.io/pineappl/docs/"
3939
documentation = "https://pineappl.readthedocs.io/"
4040
changelog = "https://nnpdf.github.io/pineappl/CHANGELOG.html"
4141

0 commit comments

Comments
 (0)