Skip to content

Commit f68638d

Browse files
committed
Format
1 parent df3c0db commit f68638d

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

docs/gettingstarted/installing.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,20 +25,20 @@ ALICE uses aliBuild to build software. aliBuild:
2525

2626
According to your operating system, please follow the prerequisites below. You will find a list of packages to install and configurations to perform.
2727

28-
##### Primary supported platform:
28+
##### Primary supported platform
2929

3030
* [CentOS 7](#prereq-for-centos7)
3131
* [CentOS/AlmaLinux 8](#prereq-for-centos8)
3232
* [AlmaLinux 9](#prereq-for-alma9)
3333

34-
##### Platforms supported on a best-effort basis:
34+
##### Platforms supported on a best-effort basis
3535

3636
* [macOS Sonoma and Sequoia (14.0, 15.0)](#prereq-for-macos)
3737
* [Ubuntu (20.04 LTS, 22.04 LTS, 24.04 LTS)](#prereq-for-ubuntu)
3838
* [Fedora](#prereq-for-fedora)
3939
* Linux Mint
40-
* Follow the instructions for the Ubuntu version your Linux Mint version is based on.
41-
* Specify the corresponding Ubuntu architecture when running the `aliBuild` command using the `-a` option (e.g. `-a ubuntu2004_x86-64` for Ubuntu 20.04). Use the `-a` option also with the `alienv` command.
40+
* Follow the instructions for the Ubuntu version your Linux Mint version is based on.
41+
* Specify the corresponding Ubuntu architecture when running the `aliBuild` command using the `-a` option (e.g. `-a ubuntu2004_x86-64` for Ubuntu 20.04). Use the `-a` option also with the `alienv` command.
4242

4343
If your operating system is *not* in any list, it does not mean our software won't work on it; it will be just more difficult for you to get support for it.
4444

@@ -47,6 +47,7 @@ Only in case you cannot install aliBuild in the way described above, you can ins
4747
<h6 id="prereq-for-centos7"> aliBuild prerequisites for CentOS7 </h6>
4848

4949
With root permission, i.e. `sudo` or as `root`install the prerequisits using:
50+
5051
```bash
5152
cat << EOF > /etc/yum.repos.d/alice-system-deps.repo
5253
[alice-system-deps]
@@ -64,6 +65,7 @@ yum install -y alibuild
6465
<h6 id="prereq-for-centos8"> aliBuild prerequisites for CentOS8 </h6>
6566

6667
With root permission, i.e. `sudo` or as `root` install the prerequisits using:
68+
6769
```bash
6870
yum install -y epel-release
6971
yum install -y dnf-plugins-core
@@ -86,6 +88,7 @@ yum install -y alice-o2-full-deps alibuild
8688
<h6 id="prereq-for-alma9"> aliBuild prerequisites for AlmaLinux9 </h6>
8789

8890
With root permission, i.e. `sudo` or as `root`install the prerequisits using:
91+
8992
```bash
9093
dnf install -y epel-release dnf-plugins-core
9194
dnf update -y
@@ -120,7 +123,6 @@ Xcode bundles the necessary tools to build software in the apple ecosystem inclu
120123
* Install Homebrew using the [instructions on their webpage](https://brew.sh/).
121124
* Once installed detect any problems regarding Homebrew and your system using: `brew doctor`
122125

123-
124126
**Uninstall ROOT**<br>
125127
If you have an existing ROOT installation on your system, this will interfere with the aliBuild installation, and will cause difficult-to-debug compilation errors.
126128

@@ -138,7 +140,6 @@ Note that Homebrew does not run as root. Do not prepend sudo to any of the follo
138140
```echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> ~/.zprofile```
139141
* Close Terminal and reopen it to apply changes.
140142

141-
142143
<h6 id="prereq-for-ubuntu">aliBuild prerequisites for Ubuntu</h6>
143144

144145
ALICE software on Ubuntu is supported on a best effort basis. There is no guarantee that software builds or runs correctly. Support requests might have low priority. We were able to successfully build on:
@@ -150,13 +151,17 @@ ALICE software on Ubuntu is supported on a best effort basis. There is no guaran
150151
**Install required system packages**<br>
151152

152153
With root permissions, i.e. sudo, update your package sources:
154+
153155
```bash
154156
sudo apt update -y
155157
```
158+
156159
With root permissions, i.e. `sudo`, install the following packages:
160+
157161
```bash
158162
sudo apt install -y curl libcurl4-gnutls-dev build-essential gfortran libmysqlclient-dev xorg-dev libglu1-mesa-dev libfftw3-dev libxml2-dev git unzip autoconf automake autopoint texinfo gettext libtool libtool-bin pkg-config bison flex libperl-dev libbz2-dev swig liblzma-dev libnanomsg-dev rsync lsb-release environment-modules libglfw3-dev libtbb-dev python3-dev python3-venv python3-pip graphviz libncurses-dev software-properties-common gtk-doc-tools
159163
```
164+
160165
**Installing aliBuild**<br>
161166

162167
AliBuild, our build tool, is installed as a standard ubuntu package, provided you enable the alisw PPA repository. This is done with:
@@ -170,6 +175,7 @@ sudo apt install python3-alibuild
170175
<h6 id="prereq-for-fedora">aliBuild prerequisites for Fedora</h6>
171176

172177
With root permissions, i.e. `sudo` or as `root` install the prerequisites using:
178+
173179
```bash
174180
yum install -y epel-release
175181
yum install -y dnf-plugins-core
@@ -192,10 +198,12 @@ yum install -y alice-o2-full-deps alibuild
192198
### Configure aliBuild
193199

194200
After you are done installing alibuild you need to configure it by adding the two following lines to your `~/.bashrc`, `~/.bash_profile`, `~/.zshrc` or `~/.zprofile` (depending on your operating system and configuration):
201+
195202
```bash
196203
export ALIBUILD_WORK_DIR="$HOME/alice/sw"
197204
eval "$(alienv shell-helper)"
198205
```
206+
199207
The first line tells what directory is used as "build cache", the second line installs a "shell helper" that makes easier to run certain aliBuild-related commands.
200208

201209
You need to close and reopen your terminal for the change to be effective. The directory `~/alice/sw` will be created the first time you run aliBuild.

0 commit comments

Comments
 (0)