You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
amethyst/README.md

2.3 KiB

Amethyst

Amethyst is a fast, efficient and lightweight AUR helper and Pacman wrapper.

Made for Crystal, compatible with any Arch-based Linux distribution.

💡 Features

  • Fast and efficient!
  • Asynchronus!
  • Customizable!
  • Parallel package building
  • Install packages from the AUR and any added repositories
  • Search for packages in the AUR and any added repositories

📚 Documentation

Documentation for this project is available here!

💾 Installation

💽 From Binary

Install amethyst using cargo

  $ cargo install --path .
  $ ame help

🏗 From Source

Install amethyst from source using cargo

Debug/development builds

 $ git clone https://git.getcryst.al/crystal/software/amethyst.git && cd amethyst
 $ cargo build
 $ cargo run

Optimised/release builds

 $ git clone https://git.getcryst.al/crystal/software/amethyst.git && cd amethyst
 $ cargo install --path .

Install on non-Crystal distros

sudo pacman -S --needed base-devel pacman-contrib cargo
git clone https://git.getcryst.al/crystal/pkgbuilds/ame
cd ame && makepkg -si

Amethyst is also available as an AUR package!

📸 Screenshots

App Screenshot

🙌 Contributing

If you'd like to contribute to amethyst, please follow the Crystal Linux contributing guidelines!

This project uses rustup, to set up rust for amethyst development, please follow the guidelines below:

$ curl https://sh.rustup.rs -sSf | sh
$ rustup default stable

(Via rustup.rs)

We are also constantly looking for translators for our i18n-enabled projects! If you speak more than one language, consider helping out on our Weblate!

https://i18n.getcryst.al/engage/crystal-linux/

📜 License

GPLv3-only