Skip to content

Commit c5de5df

Browse files
committed
docs/guide-install.md: Mention using from sources
+ minor improvements here and there. Signed-off-by: Artem Bityutskiy <artem.bityutskiy@linux.intel.com>
1 parent d8c082a commit c5de5df

1 file changed

Lines changed: 19 additions & 7 deletions

File tree

docs/guide-install.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,33 @@ Author: Artem Bityutskiy <artem.bityutskiy@linux.intel.com>
1313
# Table of Contents
1414

1515
- [Pepc Packages](#pepc-packages)
16+
- [Using From Source](#using-from-source)
1617
- [Installation Script](#installation-script)
1718
- [Pepc Package Dependencies](#pepc-package-dependencies)
1819
- [Installation Using pip](#installation-using-pip)
1920
- [Using uv](#using-uv)
20-
- [sudo complication](#sudo-complication)
21+
- [Sudo Complication](#sudo-complication)
2122
- [Tab completions](#tab-completions)
2223
- [Man pages](#man-pages)
2324
- [Example of .bashrc](#example-of-bashrc)
2425

2526
# Pepc Packages
2627

27-
Some OS distributions may provide `pepc` as an installable package. However, these packages are
28+
Some Linux distributions provide `pepc` as an installable package. However, these packages are
2829
often outdated. Therefore, it is recommended to install `pepc` using `pip` or `uv` as described
2930
below.
3031

32+
# Using From Source
33+
34+
You can use `pepc` directly from the source code without installation. Clone the repository, change
35+
to the cloned directory, and run `pepc` from there.
36+
37+
```bash
38+
git clone https://github.com/intel/pepc.git
39+
cd pepc
40+
./pepc --help
41+
```
42+
3143
# Installation Script
3244

3345
If you prefer, you can skip reading this guide and use the provided installation script
@@ -119,7 +131,7 @@ uv tool install git+https://github.com/intel/pepc.git@release
119131
export PATH="$PATH:$HOME/.local/bin"
120132
```
121133

122-
# sudo complication
134+
# Sudo Complication
123135

124136
This section applies to both `pip` and `uv` installation methods.
125137

@@ -131,7 +143,7 @@ You can use standard methods to overcome this issue. One of them is using a shel
131143
in your '~/.bashrc' file:
132144

133145
```bash
134-
alias pepc="sudo VIRTUAL_ENV=$HOME/.pmtools $HOME/.pmtools/bin/pepc"
146+
alias pepc="sudo PATH=$PATH VIRTUAL_ENV=$HOME/.pmtools $HOME/.pmtools/bin/pepc"
135147
```
136148

137149
With this alias, you can run `pepc` with `sudo` transparently, for example:
@@ -147,8 +159,8 @@ Source: Linux sysfs file-system
147159
```
148160
# Tab completions
149161

150-
`pepc` supports tab completions, but it requires specific environment variables to be set. Make sure
151-
`pepc` is in your 'PATH', and use the following:
162+
`pepc` supports tab completions, but it requires specific environment variables to be set. Run the
163+
following:
152164

153165
```bash
154166
# For pip installation (adjust path if you used a different location):
@@ -194,7 +206,7 @@ Here is an example of a '$HOME/.bashrc' file that includes the necessary setting
194206

195207
```bash
196208
# === pepc settings ===
197-
VENV='$HOME/.pmtools'
209+
VENV="$HOME/.pmtools"
198210
VENV_BIN="$VENV/bin"
199211

200212
# Ensure the virtual environment's bin directory is in the PATH.

0 commit comments

Comments
 (0)