Skip to content
Merged
Changes from all commits
Commits
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
69 changes: 39 additions & 30 deletions docs/articles/en/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,38 @@ Title: Getting Started
Description: How to start using Apx on your system.
PublicationDate: 2024-10-18
Listed: true
Authors:
Authors:
- jardon
- NN708
Tags:
- getting-started
---

Apx is designed to be a versatile, distro-agnostic tool that can be installed on any Linux distribution. Follow the steps below to get Apx up and running on your system.

## Prerequisites
## Install

The easiest way to install both Apx CLI and GUI is through [Flatpak](https://flatpak.org/).

[![Get it on Flathub](https://flathub.org/api/badge?svg&locale=en)](https://flathub.org/en/apps/org.vanillaos.ApxGUI)

After installation, you can launch Apx GUI with the following command:

```bash
flatpak run org.vanillaos.ApxGUI
```

To use Apx CLI from the Flatpak package, run:

```bash
flatpak run --command=apx org.vanillaos.ApxGUI
```

## Build Manually

### Apx CLI

#### Prerequisites

Before installing Apx, ensure you have the following software installed:

Expand All @@ -20,9 +43,7 @@ Before installing Apx, ensure you have the following software installed:
3. **Podman or Docker**: Either container runtime is suitable, but Podman is recommended.
4. **Make**: This utility is used for building and installing Apx.

## Installation Procedure

### Clone the Apx Repository
#### Clone the Apx Repository

Open your terminal and run the following commands to clone the repository and navigate into it:

Expand All @@ -31,32 +52,23 @@ git clone --recursive https://github.com/Vanilla-OS/apx.git
cd apx
```

### Build Apx
#### Build Apx

Compile Apx by executing:

```bash
make build
```

### Install Apx
#### Install Apx

To install Apx system-wide, run:
To install Apx and the manual pages system-wide, run:

```bash
sudo make install
```

### Install Apx Manpages

For the manual pages, execute:

```bash
sudo make install-manpages
```

## Custom Installation Destination

You can change the installation prefix or destination using `PREFIX` and `DESTDIR`. Here are examples for custom installations:

- **Install Apx to `~/.local`**:
Expand All @@ -67,16 +79,15 @@ You can change the installation prefix or destination using `PREFIX` and `DESTDI
```

- **Install Apx to a separate root**:

```bash
make install DESTDIR=$HOME/altroot
make install-manpages DESTDIR=$HOME/altroot
```

# Getting Started with Apx-GUI
### Apx GUI

Apx-GUI provides a graphical interface for managing your Apx installations. Follow the steps below to install Apx-GUI on your system.

## Dependencies
#### Dependencies

Before you start, ensure you have the following dependencies installed:

Expand All @@ -94,9 +105,7 @@ sudo apt update
sudo apt install build-essential meson libadwaita-1-dev gettext desktop-file-utils apx
```

## Installation Procedure

### Clone the Apx-GUI Repository
#### Clone the Apx GUI Repository

Open your terminal and run the following commands to clone the repository and navigate into it:

Expand All @@ -105,9 +114,9 @@ git clone https://github.com/Vanilla-OS/apx-gui.git
cd apx-gui
```

### Build Apx-GUI
#### Build Apx GUI

Once you have cloned the repository, build Apx-GUI by running:
Once you have cloned the repository, build Apx GUI by running:

```bash
meson setup build
Expand All @@ -116,20 +125,20 @@ ninja -C build

> **NOTE:** you can set a custom installation destination by passing `--prefix=/path/to/dir` to `meson`

### Install Apx-GUI
#### Install Apx GUI

After successfully building the application, install it with the following command:

```bash
sudo ninja -C build install
```

### Run Apx-GUI
#### Run Apx GUI

You can launch Apx-GUI using the following command:
You can launch Apx GUI using the following command:

```bash
apx-gui
```

Follow these steps to successfully install and run Apx-GUI on your system. Enjoy managing your Apx installations with the graphical interface!
Follow these steps to successfully install and run Apx GUI on your system. Enjoy managing your Apx installations with the graphical interface!
Loading