From 42598676a8c1c258c0ad55f045e3d4e577ad22d8 Mon Sep 17 00:00:00 2001 From: mrshmllow Date: Sun, 18 Sep 2022 11:16:10 +1000 Subject: [PATCH] add an Amethyst getting started --- amethyst/getting-started.mdx | 40 ++++++++++++++++++++++++++++++++++++ amethyst/usage.mdx | 1 + 2 files changed, 41 insertions(+) create mode 100644 amethyst/getting-started.mdx diff --git a/amethyst/getting-started.mdx b/amethyst/getting-started.mdx new file mode 100644 index 0000000..058ea12 --- /dev/null +++ b/amethyst/getting-started.mdx @@ -0,0 +1,40 @@ +--- +title: Getting Started +weight: 20 +--- + +Amethyst is a fast, efficient and lightweight AUR helper and Pacman wrapper. Made for Crystal, compatible with any Arch-based Linux distribution. + +## Installation + +### Crystal Linux + +Amethyst is installed on Crystal Linux automatically + +### Non-Crystal Distros + +1. `sudo pacman -S --needed base-devel pacman-contrib cargo` +2. `git clone https://github.com/crystal-linux/pkgbuild.amethyst` +3. `cd pkgbuild.amethyst && makepkg -si` + +It is also in the AUR as [`ame`](https://aur.archlinux.org/packages/ame). + +## Usage + +Amethyst supports subcommands and Pacman-style flags. Read [Detailed Usage](usage) for more. + +## Configuring + +You can configure Amethyst using the `~/.config/ame/config.toml` file, which is automatically created. Each key is explained in [Config Keys](config). + +```toml +# ~/.config/ame/config.toml + +[base] +pacdiff_warn = true +paccache_keep = 0 +paccache_keep_ins_pkgs = true + +[bin] +sudo = 'sudo' +``` diff --git a/amethyst/usage.mdx b/amethyst/usage.mdx index c65cf28..337bcdc 100644 --- a/amethyst/usage.mdx +++ b/amethyst/usage.mdx @@ -1,5 +1,6 @@ --- title: Detailed Usage +weight: 10 --- ### Basic usage