README.md

Paxy - A package manager that gets out of your way

Table of Contents

• Paxy - A package manager that gets out of your way
  • Table of Contents
  • For Users
    • Commandline Usage
    • User Guide
  • For Developers
    • API Documentation
    • Cloning
      • HTTPS
      • SSH
    • Packaging
      • Arch Linux
    • Continuous Integration (CI)

For Users

Commandline Usage

Note This section will be updated with the actual help text of the tool when we determine that the commandline interface is reasonably stable.

Run

paxy --help

to see the various commandline options available.

User Guide

Please visit https://pax-hub.github.io/book-paxy for a detailed user guide.

For Developers

API Documentation

Please visit https://pax-hub.github.io/paxy the full API documentation.

Cloning

To download the source code to your local computer for testing, or for development, you can clone from the remote repository using either SSH, or HTTPS. Below are instructions on how to do so using GitHub hosted code as remote.

HTTPS

git clone https://github.com/pax-hub/paxy.git 

OR

SSH

git clone git@github.com:pax-hub/paxy.git

Packaging

Arch Linux

Change to the project directory (cd paxy) and run any of the below scripts:

• sh packaging/archlinux/setup.sh <MODE>: Builds and installs a package

• sh packaging/archlinux/build-package.sh <MODE>: Just builds a package without installing it locally

• sh packaging/archlinux/install-package.sh <MODE>: Just installs a package locally, except if no built package is detected, a package is built.

• where <MODE> can be one of the below

  1. local: Selects paxy-local from the local project that you have cloned already.
  2. git: Selects paxy-git from the latest git commit.
  3. stable: Selects paxy from the git tag corresponding to the pkgver specified in the PKGBUILD. If pkgver=0.0.1, then the git tag v0.0.1 is used for packaging.

Note: Any additional parameters passed to the above scripts are automatically sent to makepkg or pacman (whichever is applicable).

Continuous Integration (CI)

TODO