From 6b002fff52fb410804bee70242e812dcc6b292b5 Mon Sep 17 00:00:00 2001 From: aminnairi <18418459+aminnairi@users.noreply.github.com> Date: Thu, 4 Jan 2024 14:15:16 +0100 Subject: [PATCH] added emojis for the specific error codes --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 079221f..9f8fabd 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ Note that a friendly error message will also appear in case an error occurs, tha This is documented in case you want to include this script in a bigger program or system and you probably don't ever need to read the following if you are a end-user of this script. -### 1 (ERROR_BECAUSE_ROOT) +### 🪲 1 (ERROR_BECAUSE_ROOT) This error code is returned whenever you try to run this script as root. @@ -80,7 +80,7 @@ This script should only be run as the unprivileged user that has `sudo` access o Morever, this script contains routines that needs to be run as a non-root, for instance, the installation of Arch User Repository packages. -### 2 (ERROR_BECAUSE_NOT_ARCH_LINUX) +### 🪲 2 (ERROR_BECAUSE_NOT_ARCH_LINUX) This error code is returned whenever you try to run this script in an operating system that has no `pacman` executable installed. @@ -88,7 +88,7 @@ This script has been made specifically to install this configuration for Arch op Feel free to fork this project and to update its source-code if you wish to support other operating systems as well. You are encouraged to propose pull requests as well. -### 3 (ERROR_BECAUSE_TOO_MUCH_ARGUMENTS_PROVDED) +### 🪲 3 (ERROR_BECAUSE_TOO_MUCH_ARGUMENTS_PROVDED) This error code is returned whenever you try to call this script with too much arguments. @@ -96,19 +96,19 @@ Too much arguments means that you tried to pass more than one argument, since th You can find the list of available configuration at the [`ansible`](./ansible) folder (every file that ends with a `*.yml` extension is a playbook). -### 4 (ERROR_BECAUSE_ANSIBLE_INSTALLATION_FAILED) +### 🪲 4 (ERROR_BECAUSE_ANSIBLE_INSTALLATION_FAILED) This error code is returned whenever you try to call this script and your operating system does not have the `ansible` package installed. If the installation of `ansible` has failed, this script will return the error, otherwise, it will simply continue with the installation. -### 5 (ERROR_BECAUSE_PLAYBOOK_INVALID_OR_NOT_FOUND) +### 🪲 5 (ERROR_BECAUSE_PLAYBOOK_INVALID_OR_NOT_FOUND) This error code is returned whenever you try to call this script interactively, meaning you did not provide any path to a playbook, and this script will let you choose for a wanted configuration. If the index you choosed is incorrect, then the error will be returned. -### 6 (ERROR_BECAUSE_PLAYBOOK_PATH_DOES_NOT_EXIST) +### 🪲 6 (ERROR_BECAUSE_PLAYBOOK_PATH_DOES_NOT_EXIST) This error code is returned whenever you try to call this script with an argument, which is the path to a playbook (configuration for the installation) you know you want to use.