Skip to content

Commit

Permalink
docs: Fix admonitions syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
tomlin7 committed Oct 24, 2024
1 parent 317ca1b commit 598e7b5
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 26 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,20 @@ $ source ./.venv/bin/activate
> Linux distribtions require some system packages to be installed prior to the poetry installation.
>
> For Debian based distributions,
>
> ```bash
> $ sudo apt install python3-dev tcl-dev tk-dev \
> fontconfig libfontconfig1 libfontconfig1-dev \
> cmake cmake-data extra-cmake-modules build-essential
> $ sudo apt install fontconfig libfontconfig1 libfontconfig1-dev cmake cmake-data extra-cmake-modules build-essential
> $ python -m pip install scikit-build
> ```
>
> For Arch Linux based distributions,
>
> ```bash
> $ sudo pacman -Sy
> $ sudo pacman -S base-devel cmake extra-cmake-modules \
> fontconfig tcl tk
> $ sudo pacman -S base-devel cmake extra-cmake-modules fontconfig tcl tk
> $ python -m pip install scikit-build
> $ python -m pip install tkextrafont
> ```
In the root directory, run `poetry install`. Try to launch biscuit from source with simply `biscuit` (or `poetry run biscuit`) and make sure everything looks good.
Expand Down
38 changes: 17 additions & 21 deletions docs/getting-started/installation.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Installation

> [!NOTE]
> Python 3.11 or above is required for building Biscuit.
!!! Note
Python 3.11 or above is required for building Biscuit.

Recommended way to install Biscuit is via pip:

Expand All @@ -11,25 +11,21 @@ pip install biscuit-editor

Try running `biscuit --version` in your terminal to check if the installation was successful.

> [!IMPORTANT]
> Linux distribtions require some system packages to be installed prior to the installation.
>
> For Debian based distributions,
> ```bash
> $ sudo apt install python3-dev tcl-dev tk-dev \
> fontconfig libfontconfig1 libfontconfig1-dev \
> cmake cmake-data extra-cmake-modules build-essential
> $ python -m pip install scikit-build
> ```
>
> For Arch Linux based distributions,
> ```bash
> $ sudo pacman -Sy
> $ sudo pacman -S base-devel cmake extra-cmake-modules \
> fontconfig tcl tk
> $ python -m pip install scikit-build
> $ python -m pip install tkextrafont
> ```
!!! Info "Pre-requisites for Linux"
Linux distribtions require some system packages to be installed prior to the installation.

For Debian based distributions,
```bash
$ sudo apt install fontconfig libfontconfig1 libfontconfig1-dev cmake cmake-data extra-cmake-modules build-essential
$ python3 -m pip install scikit-build
```
For Arch Linux based distributions,
```bash
$ sudo pacman -Sy
$ sudo pacman -S base-devel cmake extra-cmake-modules fontconfig tcl tk
$ python -m pip install scikit-build
$ python -m pip install tkextrafont
```

For compiling from source code, please check the [installation guide](https://github.com/tomlin7/biscuit/tree/main/scripts).

Expand Down

0 comments on commit 598e7b5

Please sign in to comment.