Skip to content

Fix formatting in prerequisites #295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ddobrigk merged 2 commits into from
May 23, 2025
Merged

Fix formatting in prerequisites #295

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fddb003
Fix formatting.
hscheid May 23, 2025
9b690b0
Add Linux Mint prerequisits
hscheid May 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions docs/gettingstarted/installing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,15 @@
* [macOS Sonoma and Sequoia (14.0, 15.0)](#prereq-for-macos)
* [Ubuntu (20.04 LTS, 22.04 LTS, 24.04 LTS)](#prereq-for-ubuntu)
* [Fedora](#prereq-for-fedora)
* Linux Mint
* Follow the instructions for the Ubuntu version your Linux Mint version is based on.
* 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.

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.

Only in case you cannot install aliBuild in the way described above, you can install aliBuild manually. This procedure should only be used as a fall-back, in case you cannot follow the instructions for your operating system linked above.


<h6 id=<prereq-for-centos7> aliBuild prerequisites for CentOS7 </h6>
<h6 id="prereq-for-centos7"> aliBuild prerequisites for CentOS7 </h6>

With root permission, i.e. `sudo` or as `root`install the prerequisits using:
```bash
Expand All @@ -54,12 +56,12 @@
gpgcheck=0
EOF
yum update -y
yum install -y alice-o2-full-deps

Check failure on line 59 in docs/gettingstarted/installing.md

View workflow job for this annotation

GitHub Actions / PR formatting / whitespace

Trailing spaces 

Remove the trailing spaces at the end of the line.
yum update -y
yum install -y alibuild
```

<h6 id=<prereq-for-centos8> aliBuild prerequisites for CentOS8 </h6>
<h6 id="prereq-for-centos8"> aliBuild prerequisites for CentOS8 </h6>

With root permission, i.e. `sudo` or as `root` install the prerequisits using:
```bash
Expand Down Expand Up @@ -160,7 +162,7 @@
AliBuild, our build tool, is installed as a standard ubuntu package, provided you enable the alisw PPA repository. This is done with:

```bash
sudo add-apt-repository ppa:alisw/ppa

Check failure on line 165 in docs/gettingstarted/installing.md

View workflow job for this annotation

GitHub Actions / PR formatting / whitespace

Trailing spaces 

Remove the trailing spaces at the end of the line.
sudo apt update
sudo apt install python3-alibuild
```
Expand Down Expand Up @@ -189,7 +191,7 @@

### Configure aliBuild

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):
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):
```bash
export ALIBUILD_WORK_DIR="$HOME/alice/sw"
eval "$(alienv shell-helper)"
Expand All @@ -198,7 +200,7 @@

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.

""Note that this directory tends to grow in size over time, and it is the one you need to remove in case of cleanups.""
Note that this directory tends to grow in size over time, and it is the one you need to remove in case of cleanups.

When `aliBuild`is installed on your computer and your prerequisits are statisfied, you can move to the next step.

Expand Down
Loading