From 497baa9abc8d900e6a6a3db33ec0f38ffe62906d Mon Sep 17 00:00:00 2001
From: Michal <michal@tar.black>
Date: Thu, 21 Jul 2022 14:20:31 +0100
Subject: [PATCH] Reworked example

---
 example-mlc.toml | 26 --------------------------
 example/mlc.toml | 32 ++++++++++++++++++++++++++++++++
 2 files changed, 32 insertions(+), 26 deletions(-)
 delete mode 100644 example-mlc.toml
 create mode 100644 example/mlc.toml

diff --git a/example-mlc.toml b/example-mlc.toml
deleted file mode 100644
index 09d8e5a..0000000
--- a/example-mlc.toml
+++ /dev/null
@@ -1,26 +0,0 @@
-mode = "repository"
-name = "test"
-
-repo = [
-	"1::amethyst",
-	"1::jade",
-	"2::notop-git!",
-	"3::slippy-rb"
-]
-
-urls = [
-	"https://github.com/crystal-linux/%repo%",
-	"https://aur.archlinux.org/%repo%",
-	"https://github.com/jnats/%repo%"
-]
-
-# in this example, mlc will create a repository called "test", with 4 packages
-# these packages will be expanded based on the index number they have (index_number::package)
-# to demonstrate, the ones in this config will expand to the following:
-#
-# https://github.com/crystal-linux/ame
-# https://github.com/crystal-linux/jade
-# https://aur.archlinux.org/notop-git
-# https://github.com/jnats/slippy-rb
-#
-# when in repository mode, malachite only pulls the PKGBUILD file from the repository (all we need to build the packages from src)
\ No newline at end of file
diff --git a/example/mlc.toml b/example/mlc.toml
new file mode 100644
index 0000000..215276d
--- /dev/null
+++ b/example/mlc.toml
@@ -0,0 +1,32 @@
+mode = "repository"
+name = "test"
+sign = false
+
+repo = [
+	"1::amethyst",
+	"1::jade!",
+	"2::notop-git",
+	"3::slippy-rb"
+]
+
+urls = [
+	"https://github.com/crystal-linux/%repo%",
+	"https://aur.archlinux.org/%repo%",
+	"https://github.com/jnats/%repo%"
+]
+
+# In this example, Malachite will create a repository called "test", with 4 packages
+# These packages will be expanded based on the index number they have (index_number::package)
+# To demonstrate, the ones in this config will expand to the following:
+#
+# https://github.com/crystal-linux/ame
+# https://github.com/crystal-linux/jade
+# https://aur.archlinux.org/notop-git
+# https://github.com/jnats/slippy-rb
+#
+# The "name" option specifies the name of the pacman repository.
+# The "sign" option specifies whether the built packages should be signed, which is recommended for all pacman repositories.
+# When in repository mode, malachite only pulls the PKGBUILD file from the git repository (all we need to build the packages from src)
+#
+# Additionally, packages are built in the order of priority, so packages with a higher priority (denoted by "!"s appended to the name) will be built first.
+# In this case, jade has a higher priority than amethyst, so it will be built first.
\ No newline at end of file